Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ test('remote Project capabilities do not dispatch Client-local actions', async (
projects: [],
projectCapabilities: {
chooseClientDirectory: false,
chooseHostDirectory: false,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,14 @@ import {

const LOCAL_CAPABILITIES = {
chooseClientDirectory: true,
chooseHostDirectory: false,
selectNoProject: true,
setLocalDefault: true,
viewClientPath: true,
} as const;
const REMOTE_CAPABILITIES = {
chooseClientDirectory: false,
chooseHostDirectory: true,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand DownExpand Up@@ -215,6 +217,7 @@ test('does not silently replace a stale Project preference with another Project'

test('does not expose Client directory actions for a remote Host', async () => {
let pickerCalls = 0;
const directoryRequests: unknown[] = [];
const service = createProjectManagementService({
capabilities: REMOTE_CAPABILITIES,
catalog: {
Expand All@@ -232,6 +235,17 @@ test('does not expose Client directory actions for a remote Host', async () => {
archive: unexpected,
restore: unexpected,
},
directoryCatalog: {
listDirectoryRoots: async () => [{ id: 'home', label: '~' }],
listDirectories: async (rootId, segments) => {
directoryRequests.push({ rootId, segments });
return [{ name: 'project' }];
},
registerDirectory: async (rootId, segments) => {
directoryRequests.push({ rootId, segments, register: true });
return { id: 'added', name: 'Added', locations: [], available: true };
},
},
chooseDirectory: async () => {
pickerCalls += 1;
return '/client/path';
Expand All@@ -257,6 +271,19 @@ test('does not expose Client directory actions for a remote Host', async () => {
path: '/host/project',
});
assert.equal(pickerCalls, 0);
assert.deepEqual(await service.directoryRoots(), [{ id: 'home', label: '~' }]);
assert.deepEqual(
await service.listDirectory({ rootId: 'home', segments: ['work'] }),
[{ name: 'project' }],
);
assert.equal(
(await service.registerDirectory({ rootId: 'home', segments: ['work', 'project'] })).id,
'added',
);
assert.deepEqual(directoryRequests, [
{ rootId: 'home', segments: ['work'] },
{ rootId: 'home', segments: ['work', 'project'], register: true },
]);
});

function managementCatalog(catalog: ProjectCatalog): ProjectManagementCatalog {
Expand Down
6 changes: 6 additions & 0 deletions apps/desktop/src/main/app-ipc-main.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,12 @@ export function registerAppIpc(
);
targetIpc.handle('projects:add', (_event, options?: { select?: unknown }) =>
deps.projectManagement.add({ select: options?.select !== false }));
handleReconnectableRead(targetIpc, 'projects:directoryRoots', () =>
deps.projectManagement.directoryRoots());
handleReconnectableRead(targetIpc, 'projects:listDirectory', (_event, input: unknown) =>
deps.projectManagement.listDirectory(input));
targetIpc.handle('projects:registerDirectory', (_event, input: unknown) =>
deps.projectManagement.registerDirectory(input));
targetIpc.handle('projects:select', (_event, projectId: unknown) =>
deps.projectManagement.select(projectId));
targetIpc.handle('projects:relink', (_event, projectId: unknown) =>
Expand Down
65 changes: 65 additions & 0 deletions apps/desktop/src/main/project-management-service.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import { findProjectByIdentity, type ProjectRecord } from '@maka/core/project';
import type {
DesktopProjectCapabilities,
DesktopProjectDirectoryEntry,
DesktopProjectDirectoryRoot,
DesktopProjectSnapshot,
} from '../preload/bridge-contract.js';
import type { CurrentProjectSelection } from './project-root-controller.js';
Expand All@@ -20,6 +22,9 @@ export interface ProjectManagementService {
projectId: unknown,
): Promise<{ project: ProjectRecord | null; path: string }>;
relink(projectId: unknown): Promise<DirectoryActionResult>;
directoryRoots(): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectory(input: unknown): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(input: unknown): Promise<ProjectRecord>;
/**
* The on-disk path of a catalogued project, for surfaces that need to open
* it. Returns null when the project is unknown, archived, or its folder is
Expand All@@ -42,8 +47,18 @@ export interface ProjectManagementCatalog {
restore(projectId: string): Promise<ProjectRecord>;
}

export interface ProjectDirectoryCatalog {
listDirectoryRoots(): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectories(
rootId: string,
segments: readonly string[],
): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(rootId: string, segments: readonly string[]): Promise<ProjectRecord>;
}

export function createProjectManagementService(deps: {
catalog: ProjectManagementCatalog;
directoryCatalog?: ProjectDirectoryCatalog;
chooseDirectory(): Promise<string | undefined>;
selection: {
currentSelection(): Promise<CurrentProjectSelection>;
Expand DownExpand Up@@ -130,6 +145,26 @@ export function createProjectManagementService(deps: {
return { ok: true, project };
},

directoryRoots() {
return requireHostDirectoryActions(deps).listDirectoryRoots();
},

listDirectory(input) {
const directory = requireDirectoryInput(input);
return requireHostDirectoryActions(deps).listDirectories(
directory.rootId,
directory.segments,
);
},

registerDirectory(input) {
const directory = requireDirectoryInput(input);
return requireHostDirectoryActions(deps).registerDirectory(
directory.rootId,
directory.segments,
);
},

async pathFor(projectId) {
if (!deps.capabilities.viewClientPath) return null;
const id = requireProjectId(projectId);
Expand All@@ -155,6 +190,36 @@ export function createProjectManagementService(deps: {
};
}

function requireHostDirectoryActions(
deps: {
readonly capabilities: DesktopProjectCapabilities;
readonly directoryCatalog?: ProjectDirectoryCatalog;
},
): ProjectDirectoryCatalog {
if (!deps.capabilities.chooseHostDirectory || !deps.directoryCatalog) {
throw new Error('This Runtime Host does not publish project directories');
}
return deps.directoryCatalog;
}

function requireDirectoryInput(value: unknown): {
readonly rootId: string;
readonly segments: readonly string[];
} {
if (!value || typeof value !== 'object' || Array.isArray(value)) {
throw new TypeError('Invalid project directory');
}
const input = value as { rootId?: unknown; segments?: unknown };
if (
typeof input.rootId !== 'string' ||
!Array.isArray(input.segments) ||
!input.segments.every((segment) => typeof segment === 'string')
) {
throw new TypeError('Invalid project directory');
}
return { rootId: input.rootId, segments: input.segments };
}

function requireLocalDirectoryActions(
deps: { readonly capabilities: DesktopProjectCapabilities },
): void {
Expand Down
3 changes: 3 additions & 0 deletions apps/desktop/src/main/runtime-host-boot.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -751,6 +751,7 @@ function registerHostClientIpc(
}));
const targetProjectManagement = createProjectManagementService({
catalog: targetProjectCatalog,
directoryCatalog: targetProjectCatalog,
chooseDirectory: async () => {
const result = await mainWindowController.showOpenDialog({
title: "Add project",
Expand All@@ -762,12 +763,14 @@ function registerHostClientIpc(
capabilities: target.kind === "local"
? {
chooseClientDirectory: true,
chooseHostDirectory: false,
selectNoProject: true,
setLocalDefault: true,
viewClientPath: true,
}
: {
chooseClientDirectory: false,
chooseHostDirectory: true,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand Down
53 changes: 53 additions & 0 deletions apps/desktop/src/main/runtime-host-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,9 @@ import {
type ProjectCatalogMutateResult,
type ProjectCatalogProject,
type ProjectCatalogProjectDetails,
PROJECT_DIRECTORY_MAX_ENTRIES,
type ProjectDirectoryEntry,
type ProjectDirectoryRoot,
type QueueRetractInput,
type QueueRetractResult,
type SessionCatalogFilter,
Expand DownExpand Up@@ -564,6 +567,52 @@ export class DesktopRuntimeHostClient {
return this.#projectForMutation(result);
}

async listProjectDirectoryRoots(): Promise<readonly ProjectDirectoryRoot[]> {
const result = await this.request("project.catalog.query", { kind: "directory_roots" });
if (result.kind !== "directory_roots") throw invalidProjection("Project directory roots");
return result.roots;
}

async listProjectDirectories(
rootId: string,
segments: readonly string[],
): Promise<readonly ProjectDirectoryEntry[]> {
const entries: ProjectDirectoryEntry[] = [];
let result = await this.request(
"project.catalog.query",
{ kind: "directory_list_start", rootId, segments },
);
const cursors = new Set<string>();
while (true) {
if (result.kind !== "directory_page") throw invalidProjection("Project directory");
if (result.rootId !== rootId || !sameSegments(result.segments, segments)) {
throw invalidProjection("Project directory identity");
}
if (entries.length + result.entries.length > PROJECT_DIRECTORY_MAX_ENTRIES) {
throw invalidProjection("Project directory has too many entries");
}
entries.push(...result.entries);
if (result.nextCursor === null) return entries;
if (cursors.has(result.nextCursor)) throw repeatedCursor("Project directory");
cursors.add(result.nextCursor);
result = await this.request("project.catalog.query", {
kind: "directory_list_continue",
rootId,
segments,
cursor: result.nextCursor,
});
}
}
Comment thread
M4n5ter marked this conversation as resolved.

async registerProjectDirectory(
rootId: string,
segments: readonly string[],
): Promise<ProjectCatalogProject> {
return this.#projectForMutation(
await this.#mutateProject({ kind: "register_directory", rootId, segments }),
);
}

async relinkProject(projectId: string, path: string): Promise<ProjectCatalogProject> {
return this.#projectForMutation(
await this.#mutateProject({ kind: "relink", projectId, path }),
Expand DownExpand Up@@ -1681,6 +1730,10 @@ function repeatedCursor(name: string): DesktopRuntimeHostClientError {
);
}

function sameSegments(left: readonly string[], right: readonly string[]): boolean {
return left.length === right.length && left.every((segment, index) => segment === right[index]);
}

function unstableProjection(
name: string,
sessionId: string,
Expand Down
20 changes: 18 additions & 2 deletions apps/desktop/src/main/runtime-host-project-catalog.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,16 +3,22 @@ import type {
ProjectCatalogProject,
ProjectCatalogProjectDetails,
} from "@maka/runtime-host/protocol";
import type { ProjectManagementCatalog } from "./project-management-service.js";
import type {
ProjectDirectoryCatalog,
ProjectManagementCatalog,
} from "./project-management-service.js";
import type { DesktopRuntimeHostClient } from "./runtime-host-client.js";

export interface DesktopProjectCatalog extends ProjectManagementCatalog {}
export interface DesktopProjectCatalog extends ProjectManagementCatalog, ProjectDirectoryCatalog {}

type RuntimeHostProjectClient = Pick<
DesktopRuntimeHostClient,
| "archiveProject"
| "listProjects"
| "listProjectDirectories"
| "listProjectDirectoryRoots"
| "registerProject"
| "registerProjectDirectory"
| "relinkProject"
| "renameProject"
| "restoreProject"
Expand All@@ -33,6 +39,16 @@ export function createRuntimeHostProjectCatalog(
const target = resolveTarget();
return projectRecord(target, await target.client.registerProject(path));
},
listDirectoryRoots: async () => resolveTarget().client.listProjectDirectoryRoots(),
listDirectories: async (rootId, segments) =>
resolveTarget().client.listProjectDirectories(rootId, segments),
registerDirectory: async (rootId, segments) => {
const target = resolveTarget();
return projectRecord(
target,
await target.client.registerProjectDirectory(rootId, segments),
);
},
relink: async (projectId, path) => {
const target = resolveTarget();
return projectRecord(target, await target.client.relinkProject(projectId, path));
Expand Down
19 changes: 19 additions & 0 deletions apps/desktop/src/preload/bridge-contract.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -328,11 +328,21 @@ export type DesktopRuntimeHostSshTerminalSnapshot =

export interface DesktopProjectCapabilities {
readonly chooseClientDirectory: boolean;
readonly chooseHostDirectory: boolean;
readonly selectNoProject: boolean;
readonly setLocalDefault: boolean;
readonly viewClientPath: boolean;
}

export interface DesktopProjectDirectoryRoot {
readonly id: string;
readonly label: string;
}

export interface DesktopProjectDirectoryEntry {
readonly name: string;
}

export interface DesktopProjectSnapshot {
readonly projects: readonly ProjectRecord[];
readonly capabilities: DesktopProjectCapabilities;
Expand DownExpand Up@@ -643,6 +653,15 @@ export interface MakaBridge {
add(host?: DesktopRuntimeHostRef): Promise<
{ ok: true; project: ProjectRecord; path: string } | { ok: false; reason: 'cancelled' }
>;
getDirectoryRoots(host: DesktopRuntimeHostRef): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
): Promise<ProjectRecord>;
select(
projectId: string | null,
host?: DesktopRuntimeHostRef,
Expand Down
15 changes: 15 additions & 0 deletions apps/desktop/src/preload/preload.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1735,6 +1735,21 @@ const makaBridge = {
> {
return invokeSelectedRuntimeHost(host, 'projects:add');
},
getDirectoryRoots(host: DesktopRuntimeHostRef) {
return invokeSelectedRuntimeHost(host, 'projects:directoryRoots');
},
listDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
) {
return invokeSelectedRuntimeHost(host, 'projects:listDirectory', input);
},
registerDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
) {
return invokeSelectedRuntimeHost(host, 'projects:registerDirectory', input);
},
select(
projectId: string | null,
host?: DesktopRuntimeHostRef,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(runtime-host): add remote project registration by M4n5ter · Pull Request #3145 · apache/maka · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ test('remote Project capabilities do not dispatch Client-local actions', async (
projects: [],
projectCapabilities: {
chooseClientDirectory: false,
chooseHostDirectory: false,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,14 @@ import {

const LOCAL_CAPABILITIES = {
chooseClientDirectory: true,
chooseHostDirectory: false,
selectNoProject: true,
setLocalDefault: true,
viewClientPath: true,
} as const;
const REMOTE_CAPABILITIES = {
chooseClientDirectory: false,
chooseHostDirectory: true,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand DownExpand Up@@ -215,6 +217,7 @@ test('does not silently replace a stale Project preference with another Project'

test('does not expose Client directory actions for a remote Host', async () => {
let pickerCalls = 0;
const directoryRequests: unknown[] = [];
const service = createProjectManagementService({
capabilities: REMOTE_CAPABILITIES,
catalog: {
Expand All@@ -232,6 +235,17 @@ test('does not expose Client directory actions for a remote Host', async () => {
archive: unexpected,
restore: unexpected,
},
directoryCatalog: {
listDirectoryRoots: async () => [{ id: 'home', label: '~' }],
listDirectories: async (rootId, segments) => {
directoryRequests.push({ rootId, segments });
return [{ name: 'project' }];
},
registerDirectory: async (rootId, segments) => {
directoryRequests.push({ rootId, segments, register: true });
return { id: 'added', name: 'Added', locations: [], available: true };
},
},
chooseDirectory: async () => {
pickerCalls += 1;
return '/client/path';
Expand All@@ -257,6 +271,19 @@ test('does not expose Client directory actions for a remote Host', async () => {
path: '/host/project',
});
assert.equal(pickerCalls, 0);
assert.deepEqual(await service.directoryRoots(), [{ id: 'home', label: '~' }]);
assert.deepEqual(
await service.listDirectory({ rootId: 'home', segments: ['work'] }),
[{ name: 'project' }],
);
assert.equal(
(await service.registerDirectory({ rootId: 'home', segments: ['work', 'project'] })).id,
'added',
);
assert.deepEqual(directoryRequests, [
{ rootId: 'home', segments: ['work'] },
{ rootId: 'home', segments: ['work', 'project'], register: true },
]);
});

function managementCatalog(catalog: ProjectCatalog): ProjectManagementCatalog {
Expand Down
6 changes: 6 additions & 0 deletions apps/desktop/src/main/app-ipc-main.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,12 @@ export function registerAppIpc(
);
targetIpc.handle('projects:add', (_event, options?: { select?: unknown }) =>
deps.projectManagement.add({ select: options?.select !== false }));
handleReconnectableRead(targetIpc, 'projects:directoryRoots', () =>
deps.projectManagement.directoryRoots());
handleReconnectableRead(targetIpc, 'projects:listDirectory', (_event, input: unknown) =>
deps.projectManagement.listDirectory(input));
targetIpc.handle('projects:registerDirectory', (_event, input: unknown) =>
deps.projectManagement.registerDirectory(input));
targetIpc.handle('projects:select', (_event, projectId: unknown) =>
deps.projectManagement.select(projectId));
targetIpc.handle('projects:relink', (_event, projectId: unknown) =>
Expand Down
65 changes: 65 additions & 0 deletions apps/desktop/src/main/project-management-service.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import { findProjectByIdentity, type ProjectRecord } from '@maka/core/project';
import type {
DesktopProjectCapabilities,
DesktopProjectDirectoryEntry,
DesktopProjectDirectoryRoot,
DesktopProjectSnapshot,
} from '../preload/bridge-contract.js';
import type { CurrentProjectSelection } from './project-root-controller.js';
Expand All@@ -20,6 +22,9 @@ export interface ProjectManagementService {
projectId: unknown,
): Promise<{ project: ProjectRecord | null; path: string }>;
relink(projectId: unknown): Promise<DirectoryActionResult>;
directoryRoots(): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectory(input: unknown): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(input: unknown): Promise<ProjectRecord>;
/**
* The on-disk path of a catalogued project, for surfaces that need to open
* it. Returns null when the project is unknown, archived, or its folder is
Expand All@@ -42,8 +47,18 @@ export interface ProjectManagementCatalog {
restore(projectId: string): Promise<ProjectRecord>;
}

export interface ProjectDirectoryCatalog {
listDirectoryRoots(): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectories(
rootId: string,
segments: readonly string[],
): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(rootId: string, segments: readonly string[]): Promise<ProjectRecord>;
}

export function createProjectManagementService(deps: {
catalog: ProjectManagementCatalog;
directoryCatalog?: ProjectDirectoryCatalog;
chooseDirectory(): Promise<string | undefined>;
selection: {
currentSelection(): Promise<CurrentProjectSelection>;
Expand DownExpand Up@@ -130,6 +145,26 @@ export function createProjectManagementService(deps: {
return { ok: true, project };
},

directoryRoots() {
return requireHostDirectoryActions(deps).listDirectoryRoots();
},

listDirectory(input) {
const directory = requireDirectoryInput(input);
return requireHostDirectoryActions(deps).listDirectories(
directory.rootId,
directory.segments,
);
},

registerDirectory(input) {
const directory = requireDirectoryInput(input);
return requireHostDirectoryActions(deps).registerDirectory(
directory.rootId,
directory.segments,
);
},

async pathFor(projectId) {
if (!deps.capabilities.viewClientPath) return null;
const id = requireProjectId(projectId);
Expand All@@ -155,6 +190,36 @@ export function createProjectManagementService(deps: {
};
}

function requireHostDirectoryActions(
deps: {
readonly capabilities: DesktopProjectCapabilities;
readonly directoryCatalog?: ProjectDirectoryCatalog;
},
): ProjectDirectoryCatalog {
if (!deps.capabilities.chooseHostDirectory || !deps.directoryCatalog) {
throw new Error('This Runtime Host does not publish project directories');
}
return deps.directoryCatalog;
}

function requireDirectoryInput(value: unknown): {
readonly rootId: string;
readonly segments: readonly string[];
} {
if (!value || typeof value !== 'object' || Array.isArray(value)) {
throw new TypeError('Invalid project directory');
}
const input = value as { rootId?: unknown; segments?: unknown };
if (
typeof input.rootId !== 'string' ||
!Array.isArray(input.segments) ||
!input.segments.every((segment) => typeof segment === 'string')
) {
throw new TypeError('Invalid project directory');
}
return { rootId: input.rootId, segments: input.segments };
}

function requireLocalDirectoryActions(
deps: { readonly capabilities: DesktopProjectCapabilities },
): void {
Expand Down
3 changes: 3 additions & 0 deletions apps/desktop/src/main/runtime-host-boot.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -751,6 +751,7 @@ function registerHostClientIpc(
}));
const targetProjectManagement = createProjectManagementService({
catalog: targetProjectCatalog,
directoryCatalog: targetProjectCatalog,
chooseDirectory: async () => {
const result = await mainWindowController.showOpenDialog({
title: "Add project",
Expand All@@ -762,12 +763,14 @@ function registerHostClientIpc(
capabilities: target.kind === "local"
? {
chooseClientDirectory: true,
chooseHostDirectory: false,
selectNoProject: true,
setLocalDefault: true,
viewClientPath: true,
}
: {
chooseClientDirectory: false,
chooseHostDirectory: true,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand Down
53 changes: 53 additions & 0 deletions apps/desktop/src/main/runtime-host-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,9 @@ import {
type ProjectCatalogMutateResult,
type ProjectCatalogProject,
type ProjectCatalogProjectDetails,
PROJECT_DIRECTORY_MAX_ENTRIES,
type ProjectDirectoryEntry,
type ProjectDirectoryRoot,
type QueueRetractInput,
type QueueRetractResult,
type SessionCatalogFilter,
Expand DownExpand Up@@ -564,6 +567,52 @@ export class DesktopRuntimeHostClient {
return this.#projectForMutation(result);
}

async listProjectDirectoryRoots(): Promise<readonly ProjectDirectoryRoot[]> {
const result = await this.request("project.catalog.query", { kind: "directory_roots" });
if (result.kind !== "directory_roots") throw invalidProjection("Project directory roots");
return result.roots;
}

async listProjectDirectories(
rootId: string,
segments: readonly string[],
): Promise<readonly ProjectDirectoryEntry[]> {
const entries: ProjectDirectoryEntry[] = [];
let result = await this.request(
"project.catalog.query",
{ kind: "directory_list_start", rootId, segments },
);
const cursors = new Set<string>();
while (true) {
if (result.kind !== "directory_page") throw invalidProjection("Project directory");
if (result.rootId !== rootId || !sameSegments(result.segments, segments)) {
throw invalidProjection("Project directory identity");
}
if (entries.length + result.entries.length > PROJECT_DIRECTORY_MAX_ENTRIES) {
throw invalidProjection("Project directory has too many entries");
}
entries.push(...result.entries);
if (result.nextCursor === null) return entries;
if (cursors.has(result.nextCursor)) throw repeatedCursor("Project directory");
cursors.add(result.nextCursor);
result = await this.request("project.catalog.query", {
kind: "directory_list_continue",
rootId,
segments,
cursor: result.nextCursor,
});
}
}
Comment thread
M4n5ter marked this conversation as resolved.

async registerProjectDirectory(
rootId: string,
segments: readonly string[],
): Promise<ProjectCatalogProject> {
return this.#projectForMutation(
await this.#mutateProject({ kind: "register_directory", rootId, segments }),
);
}

async relinkProject(projectId: string, path: string): Promise<ProjectCatalogProject> {
return this.#projectForMutation(
await this.#mutateProject({ kind: "relink", projectId, path }),
Expand DownExpand Up@@ -1681,6 +1730,10 @@ function repeatedCursor(name: string): DesktopRuntimeHostClientError {
);
}

function sameSegments(left: readonly string[], right: readonly string[]): boolean {
return left.length === right.length && left.every((segment, index) => segment === right[index]);
}

function unstableProjection(
name: string,
sessionId: string,
Expand Down
20 changes: 18 additions & 2 deletions apps/desktop/src/main/runtime-host-project-catalog.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,16 +3,22 @@ import type {
ProjectCatalogProject,
ProjectCatalogProjectDetails,
} from "@maka/runtime-host/protocol";
import type { ProjectManagementCatalog } from "./project-management-service.js";
import type {
ProjectDirectoryCatalog,
ProjectManagementCatalog,
} from "./project-management-service.js";
import type { DesktopRuntimeHostClient } from "./runtime-host-client.js";

export interface DesktopProjectCatalog extends ProjectManagementCatalog {}
export interface DesktopProjectCatalog extends ProjectManagementCatalog, ProjectDirectoryCatalog {}

type RuntimeHostProjectClient = Pick<
DesktopRuntimeHostClient,
| "archiveProject"
| "listProjects"
| "listProjectDirectories"
| "listProjectDirectoryRoots"
| "registerProject"
| "registerProjectDirectory"
| "relinkProject"
| "renameProject"
| "restoreProject"
Expand All@@ -33,6 +39,16 @@ export function createRuntimeHostProjectCatalog(
const target = resolveTarget();
return projectRecord(target, await target.client.registerProject(path));
},
listDirectoryRoots: async () => resolveTarget().client.listProjectDirectoryRoots(),
listDirectories: async (rootId, segments) =>
resolveTarget().client.listProjectDirectories(rootId, segments),
registerDirectory: async (rootId, segments) => {
const target = resolveTarget();
return projectRecord(
target,
await target.client.registerProjectDirectory(rootId, segments),
);
},
relink: async (projectId, path) => {
const target = resolveTarget();
return projectRecord(target, await target.client.relinkProject(projectId, path));
Expand Down
19 changes: 19 additions & 0 deletions apps/desktop/src/preload/bridge-contract.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -328,11 +328,21 @@ export type DesktopRuntimeHostSshTerminalSnapshot =

export interface DesktopProjectCapabilities {
readonly chooseClientDirectory: boolean;
readonly chooseHostDirectory: boolean;
readonly selectNoProject: boolean;
readonly setLocalDefault: boolean;
readonly viewClientPath: boolean;
}

export interface DesktopProjectDirectoryRoot {
readonly id: string;
readonly label: string;
}

export interface DesktopProjectDirectoryEntry {
readonly name: string;
}

export interface DesktopProjectSnapshot {
readonly projects: readonly ProjectRecord[];
readonly capabilities: DesktopProjectCapabilities;
Expand DownExpand Up@@ -643,6 +653,15 @@ export interface MakaBridge {
add(host?: DesktopRuntimeHostRef): Promise<
{ ok: true; project: ProjectRecord; path: string } | { ok: false; reason: 'cancelled' }
>;
getDirectoryRoots(host: DesktopRuntimeHostRef): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
): Promise<ProjectRecord>;
select(
projectId: string | null,
host?: DesktopRuntimeHostRef,
Expand Down
15 changes: 15 additions & 0 deletions apps/desktop/src/preload/preload.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1735,6 +1735,21 @@ const makaBridge = {
> {
return invokeSelectedRuntimeHost(host, 'projects:add');
},
getDirectoryRoots(host: DesktopRuntimeHostRef) {
return invokeSelectedRuntimeHost(host, 'projects:directoryRoots');
},
listDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
) {
return invokeSelectedRuntimeHost(host, 'projects:listDirectory', input);
},
registerDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
) {
return invokeSelectedRuntimeHost(host, 'projects:registerDirectory', input);
},
select(
projectId: string | null,
host?: DesktopRuntimeHostRef,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(runtime-host): add remote project registration by M4n5ter · Pull Request #3145 · apache/maka · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ test('remote Project capabilities do not dispatch Client-local actions', async (
projects: [],
projectCapabilities: {
chooseClientDirectory: false,
chooseHostDirectory: false,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,14 @@ import {

const LOCAL_CAPABILITIES = {
chooseClientDirectory: true,
chooseHostDirectory: false,
selectNoProject: true,
setLocalDefault: true,
viewClientPath: true,
} as const;
const REMOTE_CAPABILITIES = {
chooseClientDirectory: false,
chooseHostDirectory: true,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand DownExpand Up@@ -215,6 +217,7 @@ test('does not silently replace a stale Project preference with another Project'

test('does not expose Client directory actions for a remote Host', async () => {
let pickerCalls = 0;
const directoryRequests: unknown[] = [];
const service = createProjectManagementService({
capabilities: REMOTE_CAPABILITIES,
catalog: {
Expand All@@ -232,6 +235,17 @@ test('does not expose Client directory actions for a remote Host', async () => {
archive: unexpected,
restore: unexpected,
},
directoryCatalog: {
listDirectoryRoots: async () => [{ id: 'home', label: '~' }],
listDirectories: async (rootId, segments) => {
directoryRequests.push({ rootId, segments });
return [{ name: 'project' }];
},
registerDirectory: async (rootId, segments) => {
directoryRequests.push({ rootId, segments, register: true });
return { id: 'added', name: 'Added', locations: [], available: true };
},
},
chooseDirectory: async () => {
pickerCalls += 1;
return '/client/path';
Expand All@@ -257,6 +271,19 @@ test('does not expose Client directory actions for a remote Host', async () => {
path: '/host/project',
});
assert.equal(pickerCalls, 0);
assert.deepEqual(await service.directoryRoots(), [{ id: 'home', label: '~' }]);
assert.deepEqual(
await service.listDirectory({ rootId: 'home', segments: ['work'] }),
[{ name: 'project' }],
);
assert.equal(
(await service.registerDirectory({ rootId: 'home', segments: ['work', 'project'] })).id,
'added',
);
assert.deepEqual(directoryRequests, [
{ rootId: 'home', segments: ['work'] },
{ rootId: 'home', segments: ['work', 'project'], register: true },
]);
});

function managementCatalog(catalog: ProjectCatalog): ProjectManagementCatalog {
Expand Down
6 changes: 6 additions & 0 deletions apps/desktop/src/main/app-ipc-main.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,12 @@ export function registerAppIpc(
);
targetIpc.handle('projects:add', (_event, options?: { select?: unknown }) =>
deps.projectManagement.add({ select: options?.select !== false }));
handleReconnectableRead(targetIpc, 'projects:directoryRoots', () =>
deps.projectManagement.directoryRoots());
handleReconnectableRead(targetIpc, 'projects:listDirectory', (_event, input: unknown) =>
deps.projectManagement.listDirectory(input));
targetIpc.handle('projects:registerDirectory', (_event, input: unknown) =>
deps.projectManagement.registerDirectory(input));
targetIpc.handle('projects:select', (_event, projectId: unknown) =>
deps.projectManagement.select(projectId));
targetIpc.handle('projects:relink', (_event, projectId: unknown) =>
Expand Down
65 changes: 65 additions & 0 deletions apps/desktop/src/main/project-management-service.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import { findProjectByIdentity, type ProjectRecord } from '@maka/core/project';
import type {
DesktopProjectCapabilities,
DesktopProjectDirectoryEntry,
DesktopProjectDirectoryRoot,
DesktopProjectSnapshot,
} from '../preload/bridge-contract.js';
import type { CurrentProjectSelection } from './project-root-controller.js';
Expand All@@ -20,6 +22,9 @@ export interface ProjectManagementService {
projectId: unknown,
): Promise<{ project: ProjectRecord | null; path: string }>;
relink(projectId: unknown): Promise<DirectoryActionResult>;
directoryRoots(): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectory(input: unknown): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(input: unknown): Promise<ProjectRecord>;
/**
* The on-disk path of a catalogued project, for surfaces that need to open
* it. Returns null when the project is unknown, archived, or its folder is
Expand All@@ -42,8 +47,18 @@ export interface ProjectManagementCatalog {
restore(projectId: string): Promise<ProjectRecord>;
}

export interface ProjectDirectoryCatalog {
listDirectoryRoots(): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectories(
rootId: string,
segments: readonly string[],
): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(rootId: string, segments: readonly string[]): Promise<ProjectRecord>;
}

export function createProjectManagementService(deps: {
catalog: ProjectManagementCatalog;
directoryCatalog?: ProjectDirectoryCatalog;
chooseDirectory(): Promise<string | undefined>;
selection: {
currentSelection(): Promise<CurrentProjectSelection>;
Expand DownExpand Up@@ -130,6 +145,26 @@ export function createProjectManagementService(deps: {
return { ok: true, project };
},

directoryRoots() {
return requireHostDirectoryActions(deps).listDirectoryRoots();
},

listDirectory(input) {
const directory = requireDirectoryInput(input);
return requireHostDirectoryActions(deps).listDirectories(
directory.rootId,
directory.segments,
);
},

registerDirectory(input) {
const directory = requireDirectoryInput(input);
return requireHostDirectoryActions(deps).registerDirectory(
directory.rootId,
directory.segments,
);
},

async pathFor(projectId) {
if (!deps.capabilities.viewClientPath) return null;
const id = requireProjectId(projectId);
Expand All@@ -155,6 +190,36 @@ export function createProjectManagementService(deps: {
};
}

function requireHostDirectoryActions(
deps: {
readonly capabilities: DesktopProjectCapabilities;
readonly directoryCatalog?: ProjectDirectoryCatalog;
},
): ProjectDirectoryCatalog {
if (!deps.capabilities.chooseHostDirectory || !deps.directoryCatalog) {
throw new Error('This Runtime Host does not publish project directories');
}
return deps.directoryCatalog;
}

function requireDirectoryInput(value: unknown): {
readonly rootId: string;
readonly segments: readonly string[];
} {
if (!value || typeof value !== 'object' || Array.isArray(value)) {
throw new TypeError('Invalid project directory');
}
const input = value as { rootId?: unknown; segments?: unknown };
if (
typeof input.rootId !== 'string' ||
!Array.isArray(input.segments) ||
!input.segments.every((segment) => typeof segment === 'string')
) {
throw new TypeError('Invalid project directory');
}
return { rootId: input.rootId, segments: input.segments };
}

function requireLocalDirectoryActions(
deps: { readonly capabilities: DesktopProjectCapabilities },
): void {
Expand Down
3 changes: 3 additions & 0 deletions apps/desktop/src/main/runtime-host-boot.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -751,6 +751,7 @@ function registerHostClientIpc(
}));
const targetProjectManagement = createProjectManagementService({
catalog: targetProjectCatalog,
directoryCatalog: targetProjectCatalog,
chooseDirectory: async () => {
const result = await mainWindowController.showOpenDialog({
title: "Add project",
Expand All@@ -762,12 +763,14 @@ function registerHostClientIpc(
capabilities: target.kind === "local"
? {
chooseClientDirectory: true,
chooseHostDirectory: false,
selectNoProject: true,
setLocalDefault: true,
viewClientPath: true,
}
: {
chooseClientDirectory: false,
chooseHostDirectory: true,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand Down
53 changes: 53 additions & 0 deletions apps/desktop/src/main/runtime-host-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,9 @@ import {
type ProjectCatalogMutateResult,
type ProjectCatalogProject,
type ProjectCatalogProjectDetails,
PROJECT_DIRECTORY_MAX_ENTRIES,
type ProjectDirectoryEntry,
type ProjectDirectoryRoot,
type QueueRetractInput,
type QueueRetractResult,
type SessionCatalogFilter,
Expand DownExpand Up@@ -564,6 +567,52 @@ export class DesktopRuntimeHostClient {
return this.#projectForMutation(result);
}

async listProjectDirectoryRoots(): Promise<readonly ProjectDirectoryRoot[]> {
const result = await this.request("project.catalog.query", { kind: "directory_roots" });
if (result.kind !== "directory_roots") throw invalidProjection("Project directory roots");
return result.roots;
}

async listProjectDirectories(
rootId: string,
segments: readonly string[],
): Promise<readonly ProjectDirectoryEntry[]> {
const entries: ProjectDirectoryEntry[] = [];
let result = await this.request(
"project.catalog.query",
{ kind: "directory_list_start", rootId, segments },
);
const cursors = new Set<string>();
while (true) {
if (result.kind !== "directory_page") throw invalidProjection("Project directory");
if (result.rootId !== rootId || !sameSegments(result.segments, segments)) {
throw invalidProjection("Project directory identity");
}
if (entries.length + result.entries.length > PROJECT_DIRECTORY_MAX_ENTRIES) {
throw invalidProjection("Project directory has too many entries");
}
entries.push(...result.entries);
if (result.nextCursor === null) return entries;
if (cursors.has(result.nextCursor)) throw repeatedCursor("Project directory");
cursors.add(result.nextCursor);
result = await this.request("project.catalog.query", {
kind: "directory_list_continue",
rootId,
segments,
cursor: result.nextCursor,
});
}
}
Comment thread
M4n5ter marked this conversation as resolved.

async registerProjectDirectory(
rootId: string,
segments: readonly string[],
): Promise<ProjectCatalogProject> {
return this.#projectForMutation(
await this.#mutateProject({ kind: "register_directory", rootId, segments }),
);
}

async relinkProject(projectId: string, path: string): Promise<ProjectCatalogProject> {
return this.#projectForMutation(
await this.#mutateProject({ kind: "relink", projectId, path }),
Expand DownExpand Up@@ -1681,6 +1730,10 @@ function repeatedCursor(name: string): DesktopRuntimeHostClientError {
);
}

function sameSegments(left: readonly string[], right: readonly string[]): boolean {
return left.length === right.length && left.every((segment, index) => segment === right[index]);
}

function unstableProjection(
name: string,
sessionId: string,
Expand Down
20 changes: 18 additions & 2 deletions apps/desktop/src/main/runtime-host-project-catalog.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,16 +3,22 @@ import type {
ProjectCatalogProject,
ProjectCatalogProjectDetails,
} from "@maka/runtime-host/protocol";
import type { ProjectManagementCatalog } from "./project-management-service.js";
import type {
ProjectDirectoryCatalog,
ProjectManagementCatalog,
} from "./project-management-service.js";
import type { DesktopRuntimeHostClient } from "./runtime-host-client.js";

export interface DesktopProjectCatalog extends ProjectManagementCatalog {}
export interface DesktopProjectCatalog extends ProjectManagementCatalog, ProjectDirectoryCatalog {}

type RuntimeHostProjectClient = Pick<
DesktopRuntimeHostClient,
| "archiveProject"
| "listProjects"
| "listProjectDirectories"
| "listProjectDirectoryRoots"
| "registerProject"
| "registerProjectDirectory"
| "relinkProject"
| "renameProject"
| "restoreProject"
Expand All@@ -33,6 +39,16 @@ export function createRuntimeHostProjectCatalog(
const target = resolveTarget();
return projectRecord(target, await target.client.registerProject(path));
},
listDirectoryRoots: async () => resolveTarget().client.listProjectDirectoryRoots(),
listDirectories: async (rootId, segments) =>
resolveTarget().client.listProjectDirectories(rootId, segments),
registerDirectory: async (rootId, segments) => {
const target = resolveTarget();
return projectRecord(
target,
await target.client.registerProjectDirectory(rootId, segments),
);
},
relink: async (projectId, path) => {
const target = resolveTarget();
return projectRecord(target, await target.client.relinkProject(projectId, path));
Expand Down
19 changes: 19 additions & 0 deletions apps/desktop/src/preload/bridge-contract.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -328,11 +328,21 @@ export type DesktopRuntimeHostSshTerminalSnapshot =

export interface DesktopProjectCapabilities {
readonly chooseClientDirectory: boolean;
readonly chooseHostDirectory: boolean;
readonly selectNoProject: boolean;
readonly setLocalDefault: boolean;
readonly viewClientPath: boolean;
}

export interface DesktopProjectDirectoryRoot {
readonly id: string;
readonly label: string;
}

export interface DesktopProjectDirectoryEntry {
readonly name: string;
}

export interface DesktopProjectSnapshot {
readonly projects: readonly ProjectRecord[];
readonly capabilities: DesktopProjectCapabilities;
Expand DownExpand Up@@ -643,6 +653,15 @@ export interface MakaBridge {
add(host?: DesktopRuntimeHostRef): Promise<
{ ok: true; project: ProjectRecord; path: string } | { ok: false; reason: 'cancelled' }
>;
getDirectoryRoots(host: DesktopRuntimeHostRef): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
): Promise<ProjectRecord>;
select(
projectId: string | null,
host?: DesktopRuntimeHostRef,
Expand Down
15 changes: 15 additions & 0 deletions apps/desktop/src/preload/preload.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1735,6 +1735,21 @@ const makaBridge = {
> {
return invokeSelectedRuntimeHost(host, 'projects:add');
},
getDirectoryRoots(host: DesktopRuntimeHostRef) {
return invokeSelectedRuntimeHost(host, 'projects:directoryRoots');
},
listDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
) {
return invokeSelectedRuntimeHost(host, 'projects:listDirectory', input);
},
registerDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
) {
return invokeSelectedRuntimeHost(host, 'projects:registerDirectory', input);
},
select(
projectId: string | null,
host?: DesktopRuntimeHostRef,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(runtime-host): add remote project registration by M4n5ter · Pull Request #3145 · apache/maka · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ test('remote Project capabilities do not dispatch Client-local actions', async (
projects: [],
projectCapabilities: {
chooseClientDirectory: false,
chooseHostDirectory: false,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,14 @@ import {

const LOCAL_CAPABILITIES = {
chooseClientDirectory: true,
chooseHostDirectory: false,
selectNoProject: true,
setLocalDefault: true,
viewClientPath: true,
} as const;
const REMOTE_CAPABILITIES = {
chooseClientDirectory: false,
chooseHostDirectory: true,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand DownExpand Up@@ -215,6 +217,7 @@ test('does not silently replace a stale Project preference with another Project'

test('does not expose Client directory actions for a remote Host', async () => {
let pickerCalls = 0;
const directoryRequests: unknown[] = [];
const service = createProjectManagementService({
capabilities: REMOTE_CAPABILITIES,
catalog: {
Expand All@@ -232,6 +235,17 @@ test('does not expose Client directory actions for a remote Host', async () => {
archive: unexpected,
restore: unexpected,
},
directoryCatalog: {
listDirectoryRoots: async () => [{ id: 'home', label: '~' }],
listDirectories: async (rootId, segments) => {
directoryRequests.push({ rootId, segments });
return [{ name: 'project' }];
},
registerDirectory: async (rootId, segments) => {
directoryRequests.push({ rootId, segments, register: true });
return { id: 'added', name: 'Added', locations: [], available: true };
},
},
chooseDirectory: async () => {
pickerCalls += 1;
return '/client/path';
Expand All@@ -257,6 +271,19 @@ test('does not expose Client directory actions for a remote Host', async () => {
path: '/host/project',
});
assert.equal(pickerCalls, 0);
assert.deepEqual(await service.directoryRoots(), [{ id: 'home', label: '~' }]);
assert.deepEqual(
await service.listDirectory({ rootId: 'home', segments: ['work'] }),
[{ name: 'project' }],
);
assert.equal(
(await service.registerDirectory({ rootId: 'home', segments: ['work', 'project'] })).id,
'added',
);
assert.deepEqual(directoryRequests, [
{ rootId: 'home', segments: ['work'] },
{ rootId: 'home', segments: ['work', 'project'], register: true },
]);
});

function managementCatalog(catalog: ProjectCatalog): ProjectManagementCatalog {
Expand Down
6 changes: 6 additions & 0 deletions apps/desktop/src/main/app-ipc-main.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,12 @@ export function registerAppIpc(
);
targetIpc.handle('projects:add', (_event, options?: { select?: unknown }) =>
deps.projectManagement.add({ select: options?.select !== false }));
handleReconnectableRead(targetIpc, 'projects:directoryRoots', () =>
deps.projectManagement.directoryRoots());
handleReconnectableRead(targetIpc, 'projects:listDirectory', (_event, input: unknown) =>
deps.projectManagement.listDirectory(input));
targetIpc.handle('projects:registerDirectory', (_event, input: unknown) =>
deps.projectManagement.registerDirectory(input));
targetIpc.handle('projects:select', (_event, projectId: unknown) =>
deps.projectManagement.select(projectId));
targetIpc.handle('projects:relink', (_event, projectId: unknown) =>
Expand Down
65 changes: 65 additions & 0 deletions apps/desktop/src/main/project-management-service.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import { findProjectByIdentity, type ProjectRecord } from '@maka/core/project';
import type {
DesktopProjectCapabilities,
DesktopProjectDirectoryEntry,
DesktopProjectDirectoryRoot,
DesktopProjectSnapshot,
} from '../preload/bridge-contract.js';
import type { CurrentProjectSelection } from './project-root-controller.js';
Expand All@@ -20,6 +22,9 @@ export interface ProjectManagementService {
projectId: unknown,
): Promise<{ project: ProjectRecord | null; path: string }>;
relink(projectId: unknown): Promise<DirectoryActionResult>;
directoryRoots(): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectory(input: unknown): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(input: unknown): Promise<ProjectRecord>;
/**
* The on-disk path of a catalogued project, for surfaces that need to open
* it. Returns null when the project is unknown, archived, or its folder is
Expand All@@ -42,8 +47,18 @@ export interface ProjectManagementCatalog {
restore(projectId: string): Promise<ProjectRecord>;
}

export interface ProjectDirectoryCatalog {
listDirectoryRoots(): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectories(
rootId: string,
segments: readonly string[],
): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(rootId: string, segments: readonly string[]): Promise<ProjectRecord>;
}

export function createProjectManagementService(deps: {
catalog: ProjectManagementCatalog;
directoryCatalog?: ProjectDirectoryCatalog;
chooseDirectory(): Promise<string | undefined>;
selection: {
currentSelection(): Promise<CurrentProjectSelection>;
Expand DownExpand Up@@ -130,6 +145,26 @@ export function createProjectManagementService(deps: {
return { ok: true, project };
},

directoryRoots() {
return requireHostDirectoryActions(deps).listDirectoryRoots();
},

listDirectory(input) {
const directory = requireDirectoryInput(input);
return requireHostDirectoryActions(deps).listDirectories(
directory.rootId,
directory.segments,
);
},

registerDirectory(input) {
const directory = requireDirectoryInput(input);
return requireHostDirectoryActions(deps).registerDirectory(
directory.rootId,
directory.segments,
);
},

async pathFor(projectId) {
if (!deps.capabilities.viewClientPath) return null;
const id = requireProjectId(projectId);
Expand All@@ -155,6 +190,36 @@ export function createProjectManagementService(deps: {
};
}

function requireHostDirectoryActions(
deps: {
readonly capabilities: DesktopProjectCapabilities;
readonly directoryCatalog?: ProjectDirectoryCatalog;
},
): ProjectDirectoryCatalog {
if (!deps.capabilities.chooseHostDirectory || !deps.directoryCatalog) {
throw new Error('This Runtime Host does not publish project directories');
}
return deps.directoryCatalog;
}

function requireDirectoryInput(value: unknown): {
readonly rootId: string;
readonly segments: readonly string[];
} {
if (!value || typeof value !== 'object' || Array.isArray(value)) {
throw new TypeError('Invalid project directory');
}
const input = value as { rootId?: unknown; segments?: unknown };
if (
typeof input.rootId !== 'string' ||
!Array.isArray(input.segments) ||
!input.segments.every((segment) => typeof segment === 'string')
) {
throw new TypeError('Invalid project directory');
}
return { rootId: input.rootId, segments: input.segments };
}

function requireLocalDirectoryActions(
deps: { readonly capabilities: DesktopProjectCapabilities },
): void {
Expand Down
3 changes: 3 additions & 0 deletions apps/desktop/src/main/runtime-host-boot.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -751,6 +751,7 @@ function registerHostClientIpc(
}));
const targetProjectManagement = createProjectManagementService({
catalog: targetProjectCatalog,
directoryCatalog: targetProjectCatalog,
chooseDirectory: async () => {
const result = await mainWindowController.showOpenDialog({
title: "Add project",
Expand All@@ -762,12 +763,14 @@ function registerHostClientIpc(
capabilities: target.kind === "local"
? {
chooseClientDirectory: true,
chooseHostDirectory: false,
selectNoProject: true,
setLocalDefault: true,
viewClientPath: true,
}
: {
chooseClientDirectory: false,
chooseHostDirectory: true,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand Down
53 changes: 53 additions & 0 deletions apps/desktop/src/main/runtime-host-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,9 @@ import {
type ProjectCatalogMutateResult,
type ProjectCatalogProject,
type ProjectCatalogProjectDetails,
PROJECT_DIRECTORY_MAX_ENTRIES,
type ProjectDirectoryEntry,
type ProjectDirectoryRoot,
type QueueRetractInput,
type QueueRetractResult,
type SessionCatalogFilter,
Expand DownExpand Up@@ -564,6 +567,52 @@ export class DesktopRuntimeHostClient {
return this.#projectForMutation(result);
}

async listProjectDirectoryRoots(): Promise<readonly ProjectDirectoryRoot[]> {
const result = await this.request("project.catalog.query", { kind: "directory_roots" });
if (result.kind !== "directory_roots") throw invalidProjection("Project directory roots");
return result.roots;
}

async listProjectDirectories(
rootId: string,
segments: readonly string[],
): Promise<readonly ProjectDirectoryEntry[]> {
const entries: ProjectDirectoryEntry[] = [];
let result = await this.request(
"project.catalog.query",
{ kind: "directory_list_start", rootId, segments },
);
const cursors = new Set<string>();
while (true) {
if (result.kind !== "directory_page") throw invalidProjection("Project directory");
if (result.rootId !== rootId || !sameSegments(result.segments, segments)) {
throw invalidProjection("Project directory identity");
}
if (entries.length + result.entries.length > PROJECT_DIRECTORY_MAX_ENTRIES) {
throw invalidProjection("Project directory has too many entries");
}
entries.push(...result.entries);
if (result.nextCursor === null) return entries;
if (cursors.has(result.nextCursor)) throw repeatedCursor("Project directory");
cursors.add(result.nextCursor);
result = await this.request("project.catalog.query", {
kind: "directory_list_continue",
rootId,
segments,
cursor: result.nextCursor,
});
}
}
Comment thread
M4n5ter marked this conversation as resolved.

async registerProjectDirectory(
rootId: string,
segments: readonly string[],
): Promise<ProjectCatalogProject> {
return this.#projectForMutation(
await this.#mutateProject({ kind: "register_directory", rootId, segments }),
);
}

async relinkProject(projectId: string, path: string): Promise<ProjectCatalogProject> {
return this.#projectForMutation(
await this.#mutateProject({ kind: "relink", projectId, path }),
Expand DownExpand Up@@ -1681,6 +1730,10 @@ function repeatedCursor(name: string): DesktopRuntimeHostClientError {
);
}

function sameSegments(left: readonly string[], right: readonly string[]): boolean {
return left.length === right.length && left.every((segment, index) => segment === right[index]);
}

function unstableProjection(
name: string,
sessionId: string,
Expand Down
20 changes: 18 additions & 2 deletions apps/desktop/src/main/runtime-host-project-catalog.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,16 +3,22 @@ import type {
ProjectCatalogProject,
ProjectCatalogProjectDetails,
} from "@maka/runtime-host/protocol";
import type { ProjectManagementCatalog } from "./project-management-service.js";
import type {
ProjectDirectoryCatalog,
ProjectManagementCatalog,
} from "./project-management-service.js";
import type { DesktopRuntimeHostClient } from "./runtime-host-client.js";

export interface DesktopProjectCatalog extends ProjectManagementCatalog {}
export interface DesktopProjectCatalog extends ProjectManagementCatalog, ProjectDirectoryCatalog {}

type RuntimeHostProjectClient = Pick<
DesktopRuntimeHostClient,
| "archiveProject"
| "listProjects"
| "listProjectDirectories"
| "listProjectDirectoryRoots"
| "registerProject"
| "registerProjectDirectory"
| "relinkProject"
| "renameProject"
| "restoreProject"
Expand All@@ -33,6 +39,16 @@ export function createRuntimeHostProjectCatalog(
const target = resolveTarget();
return projectRecord(target, await target.client.registerProject(path));
},
listDirectoryRoots: async () => resolveTarget().client.listProjectDirectoryRoots(),
listDirectories: async (rootId, segments) =>
resolveTarget().client.listProjectDirectories(rootId, segments),
registerDirectory: async (rootId, segments) => {
const target = resolveTarget();
return projectRecord(
target,
await target.client.registerProjectDirectory(rootId, segments),
);
},
relink: async (projectId, path) => {
const target = resolveTarget();
return projectRecord(target, await target.client.relinkProject(projectId, path));
Expand Down
19 changes: 19 additions & 0 deletions apps/desktop/src/preload/bridge-contract.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -328,11 +328,21 @@ export type DesktopRuntimeHostSshTerminalSnapshot =

export interface DesktopProjectCapabilities {
readonly chooseClientDirectory: boolean;
readonly chooseHostDirectory: boolean;
readonly selectNoProject: boolean;
readonly setLocalDefault: boolean;
readonly viewClientPath: boolean;
}

export interface DesktopProjectDirectoryRoot {
readonly id: string;
readonly label: string;
}

export interface DesktopProjectDirectoryEntry {
readonly name: string;
}

export interface DesktopProjectSnapshot {
readonly projects: readonly ProjectRecord[];
readonly capabilities: DesktopProjectCapabilities;
Expand DownExpand Up@@ -643,6 +653,15 @@ export interface MakaBridge {
add(host?: DesktopRuntimeHostRef): Promise<
{ ok: true; project: ProjectRecord; path: string } | { ok: false; reason: 'cancelled' }
>;
getDirectoryRoots(host: DesktopRuntimeHostRef): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
): Promise<ProjectRecord>;
select(
projectId: string | null,
host?: DesktopRuntimeHostRef,
Expand Down
15 changes: 15 additions & 0 deletions apps/desktop/src/preload/preload.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1735,6 +1735,21 @@ const makaBridge = {
> {
return invokeSelectedRuntimeHost(host, 'projects:add');
},
getDirectoryRoots(host: DesktopRuntimeHostRef) {
return invokeSelectedRuntimeHost(host, 'projects:directoryRoots');
},
listDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
) {
return invokeSelectedRuntimeHost(host, 'projects:listDirectory', input);
},
registerDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
) {
return invokeSelectedRuntimeHost(host, 'projects:registerDirectory', input);
},
select(
projectId: string | null,
host?: DesktopRuntimeHostRef,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' feat(runtime-host): add remote project registration by M4n5ter · Pull Request #3145 · apache/maka · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ test('remote Project capabilities do not dispatch Client-local actions', async (
projects: [],
projectCapabilities: {
chooseClientDirectory: false,
chooseHostDirectory: false,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,14 @@ import {

const LOCAL_CAPABILITIES = {
chooseClientDirectory: true,
chooseHostDirectory: false,
selectNoProject: true,
setLocalDefault: true,
viewClientPath: true,
} as const;
const REMOTE_CAPABILITIES = {
chooseClientDirectory: false,
chooseHostDirectory: true,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand DownExpand Up@@ -215,6 +217,7 @@ test('does not silently replace a stale Project preference with another Project'

test('does not expose Client directory actions for a remote Host', async () => {
let pickerCalls = 0;
const directoryRequests: unknown[] = [];
const service = createProjectManagementService({
capabilities: REMOTE_CAPABILITIES,
catalog: {
Expand All@@ -232,6 +235,17 @@ test('does not expose Client directory actions for a remote Host', async () => {
archive: unexpected,
restore: unexpected,
},
directoryCatalog: {
listDirectoryRoots: async () => [{ id: 'home', label: '~' }],
listDirectories: async (rootId, segments) => {
directoryRequests.push({ rootId, segments });
return [{ name: 'project' }];
},
registerDirectory: async (rootId, segments) => {
directoryRequests.push({ rootId, segments, register: true });
return { id: 'added', name: 'Added', locations: [], available: true };
},
},
chooseDirectory: async () => {
pickerCalls += 1;
return '/client/path';
Expand All@@ -257,6 +271,19 @@ test('does not expose Client directory actions for a remote Host', async () => {
path: '/host/project',
});
assert.equal(pickerCalls, 0);
assert.deepEqual(await service.directoryRoots(), [{ id: 'home', label: '~' }]);
assert.deepEqual(
await service.listDirectory({ rootId: 'home', segments: ['work'] }),
[{ name: 'project' }],
);
assert.equal(
(await service.registerDirectory({ rootId: 'home', segments: ['work', 'project'] })).id,
'added',
);
assert.deepEqual(directoryRequests, [
{ rootId: 'home', segments: ['work'] },
{ rootId: 'home', segments: ['work', 'project'], register: true },
]);
});

function managementCatalog(catalog: ProjectCatalog): ProjectManagementCatalog {
Expand Down
6 changes: 6 additions & 0 deletions apps/desktop/src/main/app-ipc-main.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,12 @@ export function registerAppIpc(
);
targetIpc.handle('projects:add', (_event, options?: { select?: unknown }) =>
deps.projectManagement.add({ select: options?.select !== false }));
handleReconnectableRead(targetIpc, 'projects:directoryRoots', () =>
deps.projectManagement.directoryRoots());
handleReconnectableRead(targetIpc, 'projects:listDirectory', (_event, input: unknown) =>
deps.projectManagement.listDirectory(input));
targetIpc.handle('projects:registerDirectory', (_event, input: unknown) =>
deps.projectManagement.registerDirectory(input));
targetIpc.handle('projects:select', (_event, projectId: unknown) =>
deps.projectManagement.select(projectId));
targetIpc.handle('projects:relink', (_event, projectId: unknown) =>
Expand Down
65 changes: 65 additions & 0 deletions apps/desktop/src/main/project-management-service.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import { findProjectByIdentity, type ProjectRecord } from '@maka/core/project';
import type {
DesktopProjectCapabilities,
DesktopProjectDirectoryEntry,
DesktopProjectDirectoryRoot,
DesktopProjectSnapshot,
} from '../preload/bridge-contract.js';
import type { CurrentProjectSelection } from './project-root-controller.js';
Expand All@@ -20,6 +22,9 @@ export interface ProjectManagementService {
projectId: unknown,
): Promise<{ project: ProjectRecord | null; path: string }>;
relink(projectId: unknown): Promise<DirectoryActionResult>;
directoryRoots(): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectory(input: unknown): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(input: unknown): Promise<ProjectRecord>;
/**
* The on-disk path of a catalogued project, for surfaces that need to open
* it. Returns null when the project is unknown, archived, or its folder is
Expand All@@ -42,8 +47,18 @@ export interface ProjectManagementCatalog {
restore(projectId: string): Promise<ProjectRecord>;
}

export interface ProjectDirectoryCatalog {
listDirectoryRoots(): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectories(
rootId: string,
segments: readonly string[],
): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(rootId: string, segments: readonly string[]): Promise<ProjectRecord>;
}

export function createProjectManagementService(deps: {
catalog: ProjectManagementCatalog;
directoryCatalog?: ProjectDirectoryCatalog;
chooseDirectory(): Promise<string | undefined>;
selection: {
currentSelection(): Promise<CurrentProjectSelection>;
Expand DownExpand Up@@ -130,6 +145,26 @@ export function createProjectManagementService(deps: {
return { ok: true, project };
},

directoryRoots() {
return requireHostDirectoryActions(deps).listDirectoryRoots();
},

listDirectory(input) {
const directory = requireDirectoryInput(input);
return requireHostDirectoryActions(deps).listDirectories(
directory.rootId,
directory.segments,
);
},

registerDirectory(input) {
const directory = requireDirectoryInput(input);
return requireHostDirectoryActions(deps).registerDirectory(
directory.rootId,
directory.segments,
);
},

async pathFor(projectId) {
if (!deps.capabilities.viewClientPath) return null;
const id = requireProjectId(projectId);
Expand All@@ -155,6 +190,36 @@ export function createProjectManagementService(deps: {
};
}

function requireHostDirectoryActions(
deps: {
readonly capabilities: DesktopProjectCapabilities;
readonly directoryCatalog?: ProjectDirectoryCatalog;
},
): ProjectDirectoryCatalog {
if (!deps.capabilities.chooseHostDirectory || !deps.directoryCatalog) {
throw new Error('This Runtime Host does not publish project directories');
}
return deps.directoryCatalog;
}

function requireDirectoryInput(value: unknown): {
readonly rootId: string;
readonly segments: readonly string[];
} {
if (!value || typeof value !== 'object' || Array.isArray(value)) {
throw new TypeError('Invalid project directory');
}
const input = value as { rootId?: unknown; segments?: unknown };
if (
typeof input.rootId !== 'string' ||
!Array.isArray(input.segments) ||
!input.segments.every((segment) => typeof segment === 'string')
) {
throw new TypeError('Invalid project directory');
}
return { rootId: input.rootId, segments: input.segments };
}

function requireLocalDirectoryActions(
deps: { readonly capabilities: DesktopProjectCapabilities },
): void {
Expand Down
3 changes: 3 additions & 0 deletions apps/desktop/src/main/runtime-host-boot.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -751,6 +751,7 @@ function registerHostClientIpc(
}));
const targetProjectManagement = createProjectManagementService({
catalog: targetProjectCatalog,
directoryCatalog: targetProjectCatalog,
chooseDirectory: async () => {
const result = await mainWindowController.showOpenDialog({
title: "Add project",
Expand All@@ -762,12 +763,14 @@ function registerHostClientIpc(
capabilities: target.kind === "local"
? {
chooseClientDirectory: true,
chooseHostDirectory: false,
selectNoProject: true,
setLocalDefault: true,
viewClientPath: true,
}
: {
chooseClientDirectory: false,
chooseHostDirectory: true,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand Down
53 changes: 53 additions & 0 deletions apps/desktop/src/main/runtime-host-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,9 @@ import {
type ProjectCatalogMutateResult,
type ProjectCatalogProject,
type ProjectCatalogProjectDetails,
PROJECT_DIRECTORY_MAX_ENTRIES,
type ProjectDirectoryEntry,
type ProjectDirectoryRoot,
type QueueRetractInput,
type QueueRetractResult,
type SessionCatalogFilter,
Expand DownExpand Up@@ -564,6 +567,52 @@ export class DesktopRuntimeHostClient {
return this.#projectForMutation(result);
}

async listProjectDirectoryRoots(): Promise<readonly ProjectDirectoryRoot[]> {
const result = await this.request("project.catalog.query", { kind: "directory_roots" });
if (result.kind !== "directory_roots") throw invalidProjection("Project directory roots");
return result.roots;
}

async listProjectDirectories(
rootId: string,
segments: readonly string[],
): Promise<readonly ProjectDirectoryEntry[]> {
const entries: ProjectDirectoryEntry[] = [];
let result = await this.request(
"project.catalog.query",
{ kind: "directory_list_start", rootId, segments },
);
const cursors = new Set<string>();
while (true) {
if (result.kind !== "directory_page") throw invalidProjection("Project directory");
if (result.rootId !== rootId || !sameSegments(result.segments, segments)) {
throw invalidProjection("Project directory identity");
}
if (entries.length + result.entries.length > PROJECT_DIRECTORY_MAX_ENTRIES) {
throw invalidProjection("Project directory has too many entries");
}
entries.push(...result.entries);
if (result.nextCursor === null) return entries;
if (cursors.has(result.nextCursor)) throw repeatedCursor("Project directory");
cursors.add(result.nextCursor);
result = await this.request("project.catalog.query", {
kind: "directory_list_continue",
rootId,
segments,
cursor: result.nextCursor,
});
}
}
Comment thread
M4n5ter marked this conversation as resolved.

async registerProjectDirectory(
rootId: string,
segments: readonly string[],
): Promise<ProjectCatalogProject> {
return this.#projectForMutation(
await this.#mutateProject({ kind: "register_directory", rootId, segments }),
);
}

async relinkProject(projectId: string, path: string): Promise<ProjectCatalogProject> {
return this.#projectForMutation(
await this.#mutateProject({ kind: "relink", projectId, path }),
Expand DownExpand Up@@ -1681,6 +1730,10 @@ function repeatedCursor(name: string): DesktopRuntimeHostClientError {
);
}

function sameSegments(left: readonly string[], right: readonly string[]): boolean {
return left.length === right.length && left.every((segment, index) => segment === right[index]);
}

function unstableProjection(
name: string,
sessionId: string,
Expand Down
20 changes: 18 additions & 2 deletions apps/desktop/src/main/runtime-host-project-catalog.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,16 +3,22 @@ import type {
ProjectCatalogProject,
ProjectCatalogProjectDetails,
} from "@maka/runtime-host/protocol";
import type { ProjectManagementCatalog } from "./project-management-service.js";
import type {
ProjectDirectoryCatalog,
ProjectManagementCatalog,
} from "./project-management-service.js";
import type { DesktopRuntimeHostClient } from "./runtime-host-client.js";

export interface DesktopProjectCatalog extends ProjectManagementCatalog {}
export interface DesktopProjectCatalog extends ProjectManagementCatalog, ProjectDirectoryCatalog {}

type RuntimeHostProjectClient = Pick<
DesktopRuntimeHostClient,
| "archiveProject"
| "listProjects"
| "listProjectDirectories"
| "listProjectDirectoryRoots"
| "registerProject"
| "registerProjectDirectory"
| "relinkProject"
| "renameProject"
| "restoreProject"
Expand All@@ -33,6 +39,16 @@ export function createRuntimeHostProjectCatalog(
const target = resolveTarget();
return projectRecord(target, await target.client.registerProject(path));
},
listDirectoryRoots: async () => resolveTarget().client.listProjectDirectoryRoots(),
listDirectories: async (rootId, segments) =>
resolveTarget().client.listProjectDirectories(rootId, segments),
registerDirectory: async (rootId, segments) => {
const target = resolveTarget();
return projectRecord(
target,
await target.client.registerProjectDirectory(rootId, segments),
);
},
relink: async (projectId, path) => {
const target = resolveTarget();
return projectRecord(target, await target.client.relinkProject(projectId, path));
Expand Down
19 changes: 19 additions & 0 deletions apps/desktop/src/preload/bridge-contract.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -328,11 +328,21 @@ export type DesktopRuntimeHostSshTerminalSnapshot =

export interface DesktopProjectCapabilities {
readonly chooseClientDirectory: boolean;
readonly chooseHostDirectory: boolean;
readonly selectNoProject: boolean;
readonly setLocalDefault: boolean;
readonly viewClientPath: boolean;
}

export interface DesktopProjectDirectoryRoot {
readonly id: string;
readonly label: string;
}

export interface DesktopProjectDirectoryEntry {
readonly name: string;
}

export interface DesktopProjectSnapshot {
readonly projects: readonly ProjectRecord[];
readonly capabilities: DesktopProjectCapabilities;
Expand DownExpand Up@@ -643,6 +653,15 @@ export interface MakaBridge {
add(host?: DesktopRuntimeHostRef): Promise<
{ ok: true; project: ProjectRecord; path: string } | { ok: false; reason: 'cancelled' }
>;
getDirectoryRoots(host: DesktopRuntimeHostRef): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
): Promise<ProjectRecord>;
select(
projectId: string | null,
host?: DesktopRuntimeHostRef,
Expand Down
15 changes: 15 additions & 0 deletions apps/desktop/src/preload/preload.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1735,6 +1735,21 @@ const makaBridge = {
> {
return invokeSelectedRuntimeHost(host, 'projects:add');
},
getDirectoryRoots(host: DesktopRuntimeHostRef) {
return invokeSelectedRuntimeHost(host, 'projects:directoryRoots');
},
listDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
) {
return invokeSelectedRuntimeHost(host, 'projects:listDirectory', input);
},
registerDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
) {
return invokeSelectedRuntimeHost(host, 'projects:registerDirectory', input);
},
select(
projectId: string | null,
host?: DesktopRuntimeHostRef,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(runtime-host): add remote project registration by M4n5ter · Pull Request #3145 · apache/maka · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ test('remote Project capabilities do not dispatch Client-local actions', async (
projects: [],
projectCapabilities: {
chooseClientDirectory: false,
chooseHostDirectory: false,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,14 @@ import {

const LOCAL_CAPABILITIES = {
chooseClientDirectory: true,
chooseHostDirectory: false,
selectNoProject: true,
setLocalDefault: true,
viewClientPath: true,
} as const;
const REMOTE_CAPABILITIES = {
chooseClientDirectory: false,
chooseHostDirectory: true,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand DownExpand Up@@ -215,6 +217,7 @@ test('does not silently replace a stale Project preference with another Project'

test('does not expose Client directory actions for a remote Host', async () => {
let pickerCalls = 0;
const directoryRequests: unknown[] = [];
const service = createProjectManagementService({
capabilities: REMOTE_CAPABILITIES,
catalog: {
Expand All@@ -232,6 +235,17 @@ test('does not expose Client directory actions for a remote Host', async () => {
archive: unexpected,
restore: unexpected,
},
directoryCatalog: {
listDirectoryRoots: async () => [{ id: 'home', label: '~' }],
listDirectories: async (rootId, segments) => {
directoryRequests.push({ rootId, segments });
return [{ name: 'project' }];
},
registerDirectory: async (rootId, segments) => {
directoryRequests.push({ rootId, segments, register: true });
return { id: 'added', name: 'Added', locations: [], available: true };
},
},
chooseDirectory: async () => {
pickerCalls += 1;
return '/client/path';
Expand All@@ -257,6 +271,19 @@ test('does not expose Client directory actions for a remote Host', async () => {
path: '/host/project',
});
assert.equal(pickerCalls, 0);
assert.deepEqual(await service.directoryRoots(), [{ id: 'home', label: '~' }]);
assert.deepEqual(
await service.listDirectory({ rootId: 'home', segments: ['work'] }),
[{ name: 'project' }],
);
assert.equal(
(await service.registerDirectory({ rootId: 'home', segments: ['work', 'project'] })).id,
'added',
);
assert.deepEqual(directoryRequests, [
{ rootId: 'home', segments: ['work'] },
{ rootId: 'home', segments: ['work', 'project'], register: true },
]);
});

function managementCatalog(catalog: ProjectCatalog): ProjectManagementCatalog {
Expand Down
6 changes: 6 additions & 0 deletions apps/desktop/src/main/app-ipc-main.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,12 @@ export function registerAppIpc(
);
targetIpc.handle('projects:add', (_event, options?: { select?: unknown }) =>
deps.projectManagement.add({ select: options?.select !== false }));
handleReconnectableRead(targetIpc, 'projects:directoryRoots', () =>
deps.projectManagement.directoryRoots());
handleReconnectableRead(targetIpc, 'projects:listDirectory', (_event, input: unknown) =>
deps.projectManagement.listDirectory(input));
targetIpc.handle('projects:registerDirectory', (_event, input: unknown) =>
deps.projectManagement.registerDirectory(input));
targetIpc.handle('projects:select', (_event, projectId: unknown) =>
deps.projectManagement.select(projectId));
targetIpc.handle('projects:relink', (_event, projectId: unknown) =>
Expand Down
65 changes: 65 additions & 0 deletions apps/desktop/src/main/project-management-service.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import { findProjectByIdentity, type ProjectRecord } from '@maka/core/project';
import type {
DesktopProjectCapabilities,
DesktopProjectDirectoryEntry,
DesktopProjectDirectoryRoot,
DesktopProjectSnapshot,
} from '../preload/bridge-contract.js';
import type { CurrentProjectSelection } from './project-root-controller.js';
Expand All@@ -20,6 +22,9 @@ export interface ProjectManagementService {
projectId: unknown,
): Promise<{ project: ProjectRecord | null; path: string }>;
relink(projectId: unknown): Promise<DirectoryActionResult>;
directoryRoots(): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectory(input: unknown): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(input: unknown): Promise<ProjectRecord>;
/**
* The on-disk path of a catalogued project, for surfaces that need to open
* it. Returns null when the project is unknown, archived, or its folder is
Expand All@@ -42,8 +47,18 @@ export interface ProjectManagementCatalog {
restore(projectId: string): Promise<ProjectRecord>;
}

export interface ProjectDirectoryCatalog {
listDirectoryRoots(): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectories(
rootId: string,
segments: readonly string[],
): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(rootId: string, segments: readonly string[]): Promise<ProjectRecord>;
}

export function createProjectManagementService(deps: {
catalog: ProjectManagementCatalog;
directoryCatalog?: ProjectDirectoryCatalog;
chooseDirectory(): Promise<string | undefined>;
selection: {
currentSelection(): Promise<CurrentProjectSelection>;
Expand DownExpand Up@@ -130,6 +145,26 @@ export function createProjectManagementService(deps: {
return { ok: true, project };
},

directoryRoots() {
return requireHostDirectoryActions(deps).listDirectoryRoots();
},

listDirectory(input) {
const directory = requireDirectoryInput(input);
return requireHostDirectoryActions(deps).listDirectories(
directory.rootId,
directory.segments,
);
},

registerDirectory(input) {
const directory = requireDirectoryInput(input);
return requireHostDirectoryActions(deps).registerDirectory(
directory.rootId,
directory.segments,
);
},

async pathFor(projectId) {
if (!deps.capabilities.viewClientPath) return null;
const id = requireProjectId(projectId);
Expand All@@ -155,6 +190,36 @@ export function createProjectManagementService(deps: {
};
}

function requireHostDirectoryActions(
deps: {
readonly capabilities: DesktopProjectCapabilities;
readonly directoryCatalog?: ProjectDirectoryCatalog;
},
): ProjectDirectoryCatalog {
if (!deps.capabilities.chooseHostDirectory || !deps.directoryCatalog) {
throw new Error('This Runtime Host does not publish project directories');
}
return deps.directoryCatalog;
}

function requireDirectoryInput(value: unknown): {
readonly rootId: string;
readonly segments: readonly string[];
} {
if (!value || typeof value !== 'object' || Array.isArray(value)) {
throw new TypeError('Invalid project directory');
}
const input = value as { rootId?: unknown; segments?: unknown };
if (
typeof input.rootId !== 'string' ||
!Array.isArray(input.segments) ||
!input.segments.every((segment) => typeof segment === 'string')
) {
throw new TypeError('Invalid project directory');
}
return { rootId: input.rootId, segments: input.segments };
}

function requireLocalDirectoryActions(
deps: { readonly capabilities: DesktopProjectCapabilities },
): void {
Expand Down
3 changes: 3 additions & 0 deletions apps/desktop/src/main/runtime-host-boot.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -751,6 +751,7 @@ function registerHostClientIpc(
}));
const targetProjectManagement = createProjectManagementService({
catalog: targetProjectCatalog,
directoryCatalog: targetProjectCatalog,
chooseDirectory: async () => {
const result = await mainWindowController.showOpenDialog({
title: "Add project",
Expand All@@ -762,12 +763,14 @@ function registerHostClientIpc(
capabilities: target.kind === "local"
? {
chooseClientDirectory: true,
chooseHostDirectory: false,
selectNoProject: true,
setLocalDefault: true,
viewClientPath: true,
}
: {
chooseClientDirectory: false,
chooseHostDirectory: true,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand Down
53 changes: 53 additions & 0 deletions apps/desktop/src/main/runtime-host-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,9 @@ import {
type ProjectCatalogMutateResult,
type ProjectCatalogProject,
type ProjectCatalogProjectDetails,
PROJECT_DIRECTORY_MAX_ENTRIES,
type ProjectDirectoryEntry,
type ProjectDirectoryRoot,
type QueueRetractInput,
type QueueRetractResult,
type SessionCatalogFilter,
Expand DownExpand Up@@ -564,6 +567,52 @@ export class DesktopRuntimeHostClient {
return this.#projectForMutation(result);
}

async listProjectDirectoryRoots(): Promise<readonly ProjectDirectoryRoot[]> {
const result = await this.request("project.catalog.query", { kind: "directory_roots" });
if (result.kind !== "directory_roots") throw invalidProjection("Project directory roots");
return result.roots;
}

async listProjectDirectories(
rootId: string,
segments: readonly string[],
): Promise<readonly ProjectDirectoryEntry[]> {
const entries: ProjectDirectoryEntry[] = [];
let result = await this.request(
"project.catalog.query",
{ kind: "directory_list_start", rootId, segments },
);
const cursors = new Set<string>();
while (true) {
if (result.kind !== "directory_page") throw invalidProjection("Project directory");
if (result.rootId !== rootId || !sameSegments(result.segments, segments)) {
throw invalidProjection("Project directory identity");
}
if (entries.length + result.entries.length > PROJECT_DIRECTORY_MAX_ENTRIES) {
throw invalidProjection("Project directory has too many entries");
}
entries.push(...result.entries);
if (result.nextCursor === null) return entries;
if (cursors.has(result.nextCursor)) throw repeatedCursor("Project directory");
cursors.add(result.nextCursor);
result = await this.request("project.catalog.query", {
kind: "directory_list_continue",
rootId,
segments,
cursor: result.nextCursor,
});
}
}
Comment thread
M4n5ter marked this conversation as resolved.

async registerProjectDirectory(
rootId: string,
segments: readonly string[],
): Promise<ProjectCatalogProject> {
return this.#projectForMutation(
await this.#mutateProject({ kind: "register_directory", rootId, segments }),
);
}

async relinkProject(projectId: string, path: string): Promise<ProjectCatalogProject> {
return this.#projectForMutation(
await this.#mutateProject({ kind: "relink", projectId, path }),
Expand DownExpand Up@@ -1681,6 +1730,10 @@ function repeatedCursor(name: string): DesktopRuntimeHostClientError {
);
}

function sameSegments(left: readonly string[], right: readonly string[]): boolean {
return left.length === right.length && left.every((segment, index) => segment === right[index]);
}

function unstableProjection(
name: string,
sessionId: string,
Expand Down
20 changes: 18 additions & 2 deletions apps/desktop/src/main/runtime-host-project-catalog.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,16 +3,22 @@ import type {
ProjectCatalogProject,
ProjectCatalogProjectDetails,
} from "@maka/runtime-host/protocol";
import type { ProjectManagementCatalog } from "./project-management-service.js";
import type {
ProjectDirectoryCatalog,
ProjectManagementCatalog,
} from "./project-management-service.js";
import type { DesktopRuntimeHostClient } from "./runtime-host-client.js";

export interface DesktopProjectCatalog extends ProjectManagementCatalog {}
export interface DesktopProjectCatalog extends ProjectManagementCatalog, ProjectDirectoryCatalog {}

type RuntimeHostProjectClient = Pick<
DesktopRuntimeHostClient,
| "archiveProject"
| "listProjects"
| "listProjectDirectories"
| "listProjectDirectoryRoots"
| "registerProject"
| "registerProjectDirectory"
| "relinkProject"
| "renameProject"
| "restoreProject"
Expand All@@ -33,6 +39,16 @@ export function createRuntimeHostProjectCatalog(
const target = resolveTarget();
return projectRecord(target, await target.client.registerProject(path));
},
listDirectoryRoots: async () => resolveTarget().client.listProjectDirectoryRoots(),
listDirectories: async (rootId, segments) =>
resolveTarget().client.listProjectDirectories(rootId, segments),
registerDirectory: async (rootId, segments) => {
const target = resolveTarget();
return projectRecord(
target,
await target.client.registerProjectDirectory(rootId, segments),
);
},
relink: async (projectId, path) => {
const target = resolveTarget();
return projectRecord(target, await target.client.relinkProject(projectId, path));
Expand Down
19 changes: 19 additions & 0 deletions apps/desktop/src/preload/bridge-contract.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -328,11 +328,21 @@ export type DesktopRuntimeHostSshTerminalSnapshot =

export interface DesktopProjectCapabilities {
readonly chooseClientDirectory: boolean;
readonly chooseHostDirectory: boolean;
readonly selectNoProject: boolean;
readonly setLocalDefault: boolean;
readonly viewClientPath: boolean;
}

export interface DesktopProjectDirectoryRoot {
readonly id: string;
readonly label: string;
}

export interface DesktopProjectDirectoryEntry {
readonly name: string;
}

export interface DesktopProjectSnapshot {
readonly projects: readonly ProjectRecord[];
readonly capabilities: DesktopProjectCapabilities;
Expand DownExpand Up@@ -643,6 +653,15 @@ export interface MakaBridge {
add(host?: DesktopRuntimeHostRef): Promise<
{ ok: true; project: ProjectRecord; path: string } | { ok: false; reason: 'cancelled' }
>;
getDirectoryRoots(host: DesktopRuntimeHostRef): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
): Promise<ProjectRecord>;
select(
projectId: string | null,
host?: DesktopRuntimeHostRef,
Expand Down
15 changes: 15 additions & 0 deletions apps/desktop/src/preload/preload.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1735,6 +1735,21 @@ const makaBridge = {
> {
return invokeSelectedRuntimeHost(host, 'projects:add');
},
getDirectoryRoots(host: DesktopRuntimeHostRef) {
return invokeSelectedRuntimeHost(host, 'projects:directoryRoots');
},
listDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
) {
return invokeSelectedRuntimeHost(host, 'projects:listDirectory', input);
},
registerDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
) {
return invokeSelectedRuntimeHost(host, 'projects:registerDirectory', input);
},
select(
projectId: string | null,
host?: DesktopRuntimeHostRef,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(runtime-host): add remote project registration by M4n5ter · Pull Request #3145 · apache/maka · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ test('remote Project capabilities do not dispatch Client-local actions', async (
projects: [],
projectCapabilities: {
chooseClientDirectory: false,
chooseHostDirectory: false,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,14 @@ import {

const LOCAL_CAPABILITIES = {
chooseClientDirectory: true,
chooseHostDirectory: false,
selectNoProject: true,
setLocalDefault: true,
viewClientPath: true,
} as const;
const REMOTE_CAPABILITIES = {
chooseClientDirectory: false,
chooseHostDirectory: true,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand DownExpand Up@@ -215,6 +217,7 @@ test('does not silently replace a stale Project preference with another Project'

test('does not expose Client directory actions for a remote Host', async () => {
let pickerCalls = 0;
const directoryRequests: unknown[] = [];
const service = createProjectManagementService({
capabilities: REMOTE_CAPABILITIES,
catalog: {
Expand All@@ -232,6 +235,17 @@ test('does not expose Client directory actions for a remote Host', async () => {
archive: unexpected,
restore: unexpected,
},
directoryCatalog: {
listDirectoryRoots: async () => [{ id: 'home', label: '~' }],
listDirectories: async (rootId, segments) => {
directoryRequests.push({ rootId, segments });
return [{ name: 'project' }];
},
registerDirectory: async (rootId, segments) => {
directoryRequests.push({ rootId, segments, register: true });
return { id: 'added', name: 'Added', locations: [], available: true };
},
},
chooseDirectory: async () => {
pickerCalls += 1;
return '/client/path';
Expand All@@ -257,6 +271,19 @@ test('does not expose Client directory actions for a remote Host', async () => {
path: '/host/project',
});
assert.equal(pickerCalls, 0);
assert.deepEqual(await service.directoryRoots(), [{ id: 'home', label: '~' }]);
assert.deepEqual(
await service.listDirectory({ rootId: 'home', segments: ['work'] }),
[{ name: 'project' }],
);
assert.equal(
(await service.registerDirectory({ rootId: 'home', segments: ['work', 'project'] })).id,
'added',
);
assert.deepEqual(directoryRequests, [
{ rootId: 'home', segments: ['work'] },
{ rootId: 'home', segments: ['work', 'project'], register: true },
]);
});

function managementCatalog(catalog: ProjectCatalog): ProjectManagementCatalog {
Expand Down
6 changes: 6 additions & 0 deletions apps/desktop/src/main/app-ipc-main.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,12 @@ export function registerAppIpc(
);
targetIpc.handle('projects:add', (_event, options?: { select?: unknown }) =>
deps.projectManagement.add({ select: options?.select !== false }));
handleReconnectableRead(targetIpc, 'projects:directoryRoots', () =>
deps.projectManagement.directoryRoots());
handleReconnectableRead(targetIpc, 'projects:listDirectory', (_event, input: unknown) =>
deps.projectManagement.listDirectory(input));
targetIpc.handle('projects:registerDirectory', (_event, input: unknown) =>
deps.projectManagement.registerDirectory(input));
targetIpc.handle('projects:select', (_event, projectId: unknown) =>
deps.projectManagement.select(projectId));
targetIpc.handle('projects:relink', (_event, projectId: unknown) =>
Expand Down
65 changes: 65 additions & 0 deletions apps/desktop/src/main/project-management-service.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import { findProjectByIdentity, type ProjectRecord } from '@maka/core/project';
import type {
DesktopProjectCapabilities,
DesktopProjectDirectoryEntry,
DesktopProjectDirectoryRoot,
DesktopProjectSnapshot,
} from '../preload/bridge-contract.js';
import type { CurrentProjectSelection } from './project-root-controller.js';
Expand All@@ -20,6 +22,9 @@ export interface ProjectManagementService {
projectId: unknown,
): Promise<{ project: ProjectRecord | null; path: string }>;
relink(projectId: unknown): Promise<DirectoryActionResult>;
directoryRoots(): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectory(input: unknown): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(input: unknown): Promise<ProjectRecord>;
/**
* The on-disk path of a catalogued project, for surfaces that need to open
* it. Returns null when the project is unknown, archived, or its folder is
Expand All@@ -42,8 +47,18 @@ export interface ProjectManagementCatalog {
restore(projectId: string): Promise<ProjectRecord>;
}

export interface ProjectDirectoryCatalog {
listDirectoryRoots(): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectories(
rootId: string,
segments: readonly string[],
): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(rootId: string, segments: readonly string[]): Promise<ProjectRecord>;
}

export function createProjectManagementService(deps: {
catalog: ProjectManagementCatalog;
directoryCatalog?: ProjectDirectoryCatalog;
chooseDirectory(): Promise<string | undefined>;
selection: {
currentSelection(): Promise<CurrentProjectSelection>;
Expand DownExpand Up@@ -130,6 +145,26 @@ export function createProjectManagementService(deps: {
return { ok: true, project };
},

directoryRoots() {
return requireHostDirectoryActions(deps).listDirectoryRoots();
},

listDirectory(input) {
const directory = requireDirectoryInput(input);
return requireHostDirectoryActions(deps).listDirectories(
directory.rootId,
directory.segments,
);
},

registerDirectory(input) {
const directory = requireDirectoryInput(input);
return requireHostDirectoryActions(deps).registerDirectory(
directory.rootId,
directory.segments,
);
},

async pathFor(projectId) {
if (!deps.capabilities.viewClientPath) return null;
const id = requireProjectId(projectId);
Expand All@@ -155,6 +190,36 @@ export function createProjectManagementService(deps: {
};
}

function requireHostDirectoryActions(
deps: {
readonly capabilities: DesktopProjectCapabilities;
readonly directoryCatalog?: ProjectDirectoryCatalog;
},
): ProjectDirectoryCatalog {
if (!deps.capabilities.chooseHostDirectory || !deps.directoryCatalog) {
throw new Error('This Runtime Host does not publish project directories');
}
return deps.directoryCatalog;
}

function requireDirectoryInput(value: unknown): {
readonly rootId: string;
readonly segments: readonly string[];
} {
if (!value || typeof value !== 'object' || Array.isArray(value)) {
throw new TypeError('Invalid project directory');
}
const input = value as { rootId?: unknown; segments?: unknown };
if (
typeof input.rootId !== 'string' ||
!Array.isArray(input.segments) ||
!input.segments.every((segment) => typeof segment === 'string')
) {
throw new TypeError('Invalid project directory');
}
return { rootId: input.rootId, segments: input.segments };
}

function requireLocalDirectoryActions(
deps: { readonly capabilities: DesktopProjectCapabilities },
): void {
Expand Down
3 changes: 3 additions & 0 deletions apps/desktop/src/main/runtime-host-boot.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -751,6 +751,7 @@ function registerHostClientIpc(
}));
const targetProjectManagement = createProjectManagementService({
catalog: targetProjectCatalog,
directoryCatalog: targetProjectCatalog,
chooseDirectory: async () => {
const result = await mainWindowController.showOpenDialog({
title: "Add project",
Expand All@@ -762,12 +763,14 @@ function registerHostClientIpc(
capabilities: target.kind === "local"
? {
chooseClientDirectory: true,
chooseHostDirectory: false,
selectNoProject: true,
setLocalDefault: true,
viewClientPath: true,
}
: {
chooseClientDirectory: false,
chooseHostDirectory: true,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand Down
53 changes: 53 additions & 0 deletions apps/desktop/src/main/runtime-host-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,9 @@ import {
type ProjectCatalogMutateResult,
type ProjectCatalogProject,
type ProjectCatalogProjectDetails,
PROJECT_DIRECTORY_MAX_ENTRIES,
type ProjectDirectoryEntry,
type ProjectDirectoryRoot,
type QueueRetractInput,
type QueueRetractResult,
type SessionCatalogFilter,
Expand DownExpand Up@@ -564,6 +567,52 @@ export class DesktopRuntimeHostClient {
return this.#projectForMutation(result);
}

async listProjectDirectoryRoots(): Promise<readonly ProjectDirectoryRoot[]> {
const result = await this.request("project.catalog.query", { kind: "directory_roots" });
if (result.kind !== "directory_roots") throw invalidProjection("Project directory roots");
return result.roots;
}

async listProjectDirectories(
rootId: string,
segments: readonly string[],
): Promise<readonly ProjectDirectoryEntry[]> {
const entries: ProjectDirectoryEntry[] = [];
let result = await this.request(
"project.catalog.query",
{ kind: "directory_list_start", rootId, segments },
);
const cursors = new Set<string>();
while (true) {
if (result.kind !== "directory_page") throw invalidProjection("Project directory");
if (result.rootId !== rootId || !sameSegments(result.segments, segments)) {
throw invalidProjection("Project directory identity");
}
if (entries.length + result.entries.length > PROJECT_DIRECTORY_MAX_ENTRIES) {
throw invalidProjection("Project directory has too many entries");
}
entries.push(...result.entries);
if (result.nextCursor === null) return entries;
if (cursors.has(result.nextCursor)) throw repeatedCursor("Project directory");
cursors.add(result.nextCursor);
result = await this.request("project.catalog.query", {
kind: "directory_list_continue",
rootId,
segments,
cursor: result.nextCursor,
});
}
}
Comment thread
M4n5ter marked this conversation as resolved.

async registerProjectDirectory(
rootId: string,
segments: readonly string[],
): Promise<ProjectCatalogProject> {
return this.#projectForMutation(
await this.#mutateProject({ kind: "register_directory", rootId, segments }),
);
}

async relinkProject(projectId: string, path: string): Promise<ProjectCatalogProject> {
return this.#projectForMutation(
await this.#mutateProject({ kind: "relink", projectId, path }),
Expand DownExpand Up@@ -1681,6 +1730,10 @@ function repeatedCursor(name: string): DesktopRuntimeHostClientError {
);
}

function sameSegments(left: readonly string[], right: readonly string[]): boolean {
return left.length === right.length && left.every((segment, index) => segment === right[index]);
}

function unstableProjection(
name: string,
sessionId: string,
Expand Down
20 changes: 18 additions & 2 deletions apps/desktop/src/main/runtime-host-project-catalog.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,16 +3,22 @@ import type {
ProjectCatalogProject,
ProjectCatalogProjectDetails,
} from "@maka/runtime-host/protocol";
import type { ProjectManagementCatalog } from "./project-management-service.js";
import type {
ProjectDirectoryCatalog,
ProjectManagementCatalog,
} from "./project-management-service.js";
import type { DesktopRuntimeHostClient } from "./runtime-host-client.js";

export interface DesktopProjectCatalog extends ProjectManagementCatalog {}
export interface DesktopProjectCatalog extends ProjectManagementCatalog, ProjectDirectoryCatalog {}

type RuntimeHostProjectClient = Pick<
DesktopRuntimeHostClient,
| "archiveProject"
| "listProjects"
| "listProjectDirectories"
| "listProjectDirectoryRoots"
| "registerProject"
| "registerProjectDirectory"
| "relinkProject"
| "renameProject"
| "restoreProject"
Expand All@@ -33,6 +39,16 @@ export function createRuntimeHostProjectCatalog(
const target = resolveTarget();
return projectRecord(target, await target.client.registerProject(path));
},
listDirectoryRoots: async () => resolveTarget().client.listProjectDirectoryRoots(),
listDirectories: async (rootId, segments) =>
resolveTarget().client.listProjectDirectories(rootId, segments),
registerDirectory: async (rootId, segments) => {
const target = resolveTarget();
return projectRecord(
target,
await target.client.registerProjectDirectory(rootId, segments),
);
},
relink: async (projectId, path) => {
const target = resolveTarget();
return projectRecord(target, await target.client.relinkProject(projectId, path));
Expand Down
19 changes: 19 additions & 0 deletions apps/desktop/src/preload/bridge-contract.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -328,11 +328,21 @@ export type DesktopRuntimeHostSshTerminalSnapshot =

export interface DesktopProjectCapabilities {
readonly chooseClientDirectory: boolean;
readonly chooseHostDirectory: boolean;
readonly selectNoProject: boolean;
readonly setLocalDefault: boolean;
readonly viewClientPath: boolean;
}

export interface DesktopProjectDirectoryRoot {
readonly id: string;
readonly label: string;
}

export interface DesktopProjectDirectoryEntry {
readonly name: string;
}

export interface DesktopProjectSnapshot {
readonly projects: readonly ProjectRecord[];
readonly capabilities: DesktopProjectCapabilities;
Expand DownExpand Up@@ -643,6 +653,15 @@ export interface MakaBridge {
add(host?: DesktopRuntimeHostRef): Promise<
{ ok: true; project: ProjectRecord; path: string } | { ok: false; reason: 'cancelled' }
>;
getDirectoryRoots(host: DesktopRuntimeHostRef): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
): Promise<ProjectRecord>;
select(
projectId: string | null,
host?: DesktopRuntimeHostRef,
Expand Down
15 changes: 15 additions & 0 deletions apps/desktop/src/preload/preload.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1735,6 +1735,21 @@ const makaBridge = {
> {
return invokeSelectedRuntimeHost(host, 'projects:add');
},
getDirectoryRoots(host: DesktopRuntimeHostRef) {
return invokeSelectedRuntimeHost(host, 'projects:directoryRoots');
},
listDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
) {
return invokeSelectedRuntimeHost(host, 'projects:listDirectory', input);
},
registerDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
) {
return invokeSelectedRuntimeHost(host, 'projects:registerDirectory', input);
},
select(
projectId: string | null,
host?: DesktopRuntimeHostRef,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); feat(runtime-host): add remote project registration by M4n5ter · Pull Request #3145 · apache/maka · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,7 @@ test('remote Project capabilities do not dispatch Client-local actions', async (
projects: [],
projectCapabilities: {
chooseClientDirectory: false,
chooseHostDirectory: false,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,14 @@ import {

const LOCAL_CAPABILITIES = {
chooseClientDirectory: true,
chooseHostDirectory: false,
selectNoProject: true,
setLocalDefault: true,
viewClientPath: true,
} as const;
const REMOTE_CAPABILITIES = {
chooseClientDirectory: false,
chooseHostDirectory: true,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand DownExpand Up@@ -215,6 +217,7 @@ test('does not silently replace a stale Project preference with another Project'

test('does not expose Client directory actions for a remote Host', async () => {
let pickerCalls = 0;
const directoryRequests: unknown[] = [];
const service = createProjectManagementService({
capabilities: REMOTE_CAPABILITIES,
catalog: {
Expand All@@ -232,6 +235,17 @@ test('does not expose Client directory actions for a remote Host', async () => {
archive: unexpected,
restore: unexpected,
},
directoryCatalog: {
listDirectoryRoots: async () => [{ id: 'home', label: '~' }],
listDirectories: async (rootId, segments) => {
directoryRequests.push({ rootId, segments });
return [{ name: 'project' }];
},
registerDirectory: async (rootId, segments) => {
directoryRequests.push({ rootId, segments, register: true });
return { id: 'added', name: 'Added', locations: [], available: true };
},
},
chooseDirectory: async () => {
pickerCalls += 1;
return '/client/path';
Expand All@@ -257,6 +271,19 @@ test('does not expose Client directory actions for a remote Host', async () => {
path: '/host/project',
});
assert.equal(pickerCalls, 0);
assert.deepEqual(await service.directoryRoots(), [{ id: 'home', label: '~' }]);
assert.deepEqual(
await service.listDirectory({ rootId: 'home', segments: ['work'] }),
[{ name: 'project' }],
);
assert.equal(
(await service.registerDirectory({ rootId: 'home', segments: ['work', 'project'] })).id,
'added',
);
assert.deepEqual(directoryRequests, [
{ rootId: 'home', segments: ['work'] },
{ rootId: 'home', segments: ['work', 'project'], register: true },
]);
});

function managementCatalog(catalog: ProjectCatalog): ProjectManagementCatalog {
Expand Down
6 changes: 6 additions & 0 deletions apps/desktop/src/main/app-ipc-main.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,12 @@ export function registerAppIpc(
);
targetIpc.handle('projects:add', (_event, options?: { select?: unknown }) =>
deps.projectManagement.add({ select: options?.select !== false }));
handleReconnectableRead(targetIpc, 'projects:directoryRoots', () =>
deps.projectManagement.directoryRoots());
handleReconnectableRead(targetIpc, 'projects:listDirectory', (_event, input: unknown) =>
deps.projectManagement.listDirectory(input));
targetIpc.handle('projects:registerDirectory', (_event, input: unknown) =>
deps.projectManagement.registerDirectory(input));
targetIpc.handle('projects:select', (_event, projectId: unknown) =>
deps.projectManagement.select(projectId));
targetIpc.handle('projects:relink', (_event, projectId: unknown) =>
Expand Down
65 changes: 65 additions & 0 deletions apps/desktop/src/main/project-management-service.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import { findProjectByIdentity, type ProjectRecord } from '@maka/core/project';
import type {
DesktopProjectCapabilities,
DesktopProjectDirectoryEntry,
DesktopProjectDirectoryRoot,
DesktopProjectSnapshot,
} from '../preload/bridge-contract.js';
import type { CurrentProjectSelection } from './project-root-controller.js';
Expand All@@ -20,6 +22,9 @@ export interface ProjectManagementService {
projectId: unknown,
): Promise<{ project: ProjectRecord | null; path: string }>;
relink(projectId: unknown): Promise<DirectoryActionResult>;
directoryRoots(): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectory(input: unknown): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(input: unknown): Promise<ProjectRecord>;
/**
* The on-disk path of a catalogued project, for surfaces that need to open
* it. Returns null when the project is unknown, archived, or its folder is
Expand All@@ -42,8 +47,18 @@ export interface ProjectManagementCatalog {
restore(projectId: string): Promise<ProjectRecord>;
}

export interface ProjectDirectoryCatalog {
listDirectoryRoots(): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectories(
rootId: string,
segments: readonly string[],
): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(rootId: string, segments: readonly string[]): Promise<ProjectRecord>;
}

export function createProjectManagementService(deps: {
catalog: ProjectManagementCatalog;
directoryCatalog?: ProjectDirectoryCatalog;
chooseDirectory(): Promise<string | undefined>;
selection: {
currentSelection(): Promise<CurrentProjectSelection>;
Expand DownExpand Up@@ -130,6 +145,26 @@ export function createProjectManagementService(deps: {
return { ok: true, project };
},

directoryRoots() {
return requireHostDirectoryActions(deps).listDirectoryRoots();
},

listDirectory(input) {
const directory = requireDirectoryInput(input);
return requireHostDirectoryActions(deps).listDirectories(
directory.rootId,
directory.segments,
);
},

registerDirectory(input) {
const directory = requireDirectoryInput(input);
return requireHostDirectoryActions(deps).registerDirectory(
directory.rootId,
directory.segments,
);
},

async pathFor(projectId) {
if (!deps.capabilities.viewClientPath) return null;
const id = requireProjectId(projectId);
Expand All@@ -155,6 +190,36 @@ export function createProjectManagementService(deps: {
};
}

function requireHostDirectoryActions(
deps: {
readonly capabilities: DesktopProjectCapabilities;
readonly directoryCatalog?: ProjectDirectoryCatalog;
},
): ProjectDirectoryCatalog {
if (!deps.capabilities.chooseHostDirectory || !deps.directoryCatalog) {
throw new Error('This Runtime Host does not publish project directories');
}
return deps.directoryCatalog;
}

function requireDirectoryInput(value: unknown): {
readonly rootId: string;
readonly segments: readonly string[];
} {
if (!value || typeof value !== 'object' || Array.isArray(value)) {
throw new TypeError('Invalid project directory');
}
const input = value as { rootId?: unknown; segments?: unknown };
if (
typeof input.rootId !== 'string' ||
!Array.isArray(input.segments) ||
!input.segments.every((segment) => typeof segment === 'string')
) {
throw new TypeError('Invalid project directory');
}
return { rootId: input.rootId, segments: input.segments };
}

function requireLocalDirectoryActions(
deps: { readonly capabilities: DesktopProjectCapabilities },
): void {
Expand Down
3 changes: 3 additions & 0 deletions apps/desktop/src/main/runtime-host-boot.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -751,6 +751,7 @@ function registerHostClientIpc(
}));
const targetProjectManagement = createProjectManagementService({
catalog: targetProjectCatalog,
directoryCatalog: targetProjectCatalog,
chooseDirectory: async () => {
const result = await mainWindowController.showOpenDialog({
title: "Add project",
Expand All@@ -762,12 +763,14 @@ function registerHostClientIpc(
capabilities: target.kind === "local"
? {
chooseClientDirectory: true,
chooseHostDirectory: false,
selectNoProject: true,
setLocalDefault: true,
viewClientPath: true,
}
: {
chooseClientDirectory: false,
chooseHostDirectory: true,
selectNoProject: false,
setLocalDefault: false,
viewClientPath: false,
Expand Down
53 changes: 53 additions & 0 deletions apps/desktop/src/main/runtime-host-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,9 @@ import {
type ProjectCatalogMutateResult,
type ProjectCatalogProject,
type ProjectCatalogProjectDetails,
PROJECT_DIRECTORY_MAX_ENTRIES,
type ProjectDirectoryEntry,
type ProjectDirectoryRoot,
type QueueRetractInput,
type QueueRetractResult,
type SessionCatalogFilter,
Expand DownExpand Up@@ -564,6 +567,52 @@ export class DesktopRuntimeHostClient {
return this.#projectForMutation(result);
}

async listProjectDirectoryRoots(): Promise<readonly ProjectDirectoryRoot[]> {
const result = await this.request("project.catalog.query", { kind: "directory_roots" });
if (result.kind !== "directory_roots") throw invalidProjection("Project directory roots");
return result.roots;
}

async listProjectDirectories(
rootId: string,
segments: readonly string[],
): Promise<readonly ProjectDirectoryEntry[]> {
const entries: ProjectDirectoryEntry[] = [];
let result = await this.request(
"project.catalog.query",
{ kind: "directory_list_start", rootId, segments },
);
const cursors = new Set<string>();
while (true) {
if (result.kind !== "directory_page") throw invalidProjection("Project directory");
if (result.rootId !== rootId || !sameSegments(result.segments, segments)) {
throw invalidProjection("Project directory identity");
}
if (entries.length + result.entries.length > PROJECT_DIRECTORY_MAX_ENTRIES) {
throw invalidProjection("Project directory has too many entries");
}
entries.push(...result.entries);
if (result.nextCursor === null) return entries;
if (cursors.has(result.nextCursor)) throw repeatedCursor("Project directory");
cursors.add(result.nextCursor);
result = await this.request("project.catalog.query", {
kind: "directory_list_continue",
rootId,
segments,
cursor: result.nextCursor,
});
}
}
Comment thread
M4n5ter marked this conversation as resolved.

async registerProjectDirectory(
rootId: string,
segments: readonly string[],
): Promise<ProjectCatalogProject> {
return this.#projectForMutation(
await this.#mutateProject({ kind: "register_directory", rootId, segments }),
);
}

async relinkProject(projectId: string, path: string): Promise<ProjectCatalogProject> {
return this.#projectForMutation(
await this.#mutateProject({ kind: "relink", projectId, path }),
Expand DownExpand Up@@ -1681,6 +1730,10 @@ function repeatedCursor(name: string): DesktopRuntimeHostClientError {
);
}

function sameSegments(left: readonly string[], right: readonly string[]): boolean {
return left.length === right.length && left.every((segment, index) => segment === right[index]);
}

function unstableProjection(
name: string,
sessionId: string,
Expand Down
20 changes: 18 additions & 2 deletions apps/desktop/src/main/runtime-host-project-catalog.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,16 +3,22 @@ import type {
ProjectCatalogProject,
ProjectCatalogProjectDetails,
} from "@maka/runtime-host/protocol";
import type { ProjectManagementCatalog } from "./project-management-service.js";
import type {
ProjectDirectoryCatalog,
ProjectManagementCatalog,
} from "./project-management-service.js";
import type { DesktopRuntimeHostClient } from "./runtime-host-client.js";

export interface DesktopProjectCatalog extends ProjectManagementCatalog {}
export interface DesktopProjectCatalog extends ProjectManagementCatalog, ProjectDirectoryCatalog {}

type RuntimeHostProjectClient = Pick<
DesktopRuntimeHostClient,
| "archiveProject"
| "listProjects"
| "listProjectDirectories"
| "listProjectDirectoryRoots"
| "registerProject"
| "registerProjectDirectory"
| "relinkProject"
| "renameProject"
| "restoreProject"
Expand All@@ -33,6 +39,16 @@ export function createRuntimeHostProjectCatalog(
const target = resolveTarget();
return projectRecord(target, await target.client.registerProject(path));
},
listDirectoryRoots: async () => resolveTarget().client.listProjectDirectoryRoots(),
listDirectories: async (rootId, segments) =>
resolveTarget().client.listProjectDirectories(rootId, segments),
registerDirectory: async (rootId, segments) => {
const target = resolveTarget();
return projectRecord(
target,
await target.client.registerProjectDirectory(rootId, segments),
);
},
relink: async (projectId, path) => {
const target = resolveTarget();
return projectRecord(target, await target.client.relinkProject(projectId, path));
Expand Down
19 changes: 19 additions & 0 deletions apps/desktop/src/preload/bridge-contract.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -328,11 +328,21 @@ export type DesktopRuntimeHostSshTerminalSnapshot =

export interface DesktopProjectCapabilities {
readonly chooseClientDirectory: boolean;
readonly chooseHostDirectory: boolean;
readonly selectNoProject: boolean;
readonly setLocalDefault: boolean;
readonly viewClientPath: boolean;
}

export interface DesktopProjectDirectoryRoot {
readonly id: string;
readonly label: string;
}

export interface DesktopProjectDirectoryEntry {
readonly name: string;
}

export interface DesktopProjectSnapshot {
readonly projects: readonly ProjectRecord[];
readonly capabilities: DesktopProjectCapabilities;
Expand DownExpand Up@@ -643,6 +653,15 @@ export interface MakaBridge {
add(host?: DesktopRuntimeHostRef): Promise<
{ ok: true; project: ProjectRecord; path: string } | { ok: false; reason: 'cancelled' }
>;
getDirectoryRoots(host: DesktopRuntimeHostRef): Promise<readonly DesktopProjectDirectoryRoot[]>;
listDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
): Promise<readonly DesktopProjectDirectoryEntry[]>;
registerDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
): Promise<ProjectRecord>;
select(
projectId: string | null,
host?: DesktopRuntimeHostRef,
Expand Down
15 changes: 15 additions & 0 deletions apps/desktop/src/preload/preload.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1735,6 +1735,21 @@ const makaBridge = {
> {
return invokeSelectedRuntimeHost(host, 'projects:add');
},
getDirectoryRoots(host: DesktopRuntimeHostRef) {
return invokeSelectedRuntimeHost(host, 'projects:directoryRoots');
},
listDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
) {
return invokeSelectedRuntimeHost(host, 'projects:listDirectory', input);
},
registerDirectory(
input: { readonly rootId: string; readonly segments: readonly string[] },
host: DesktopRuntimeHostRef,
) {
return invokeSelectedRuntimeHost(host, 'projects:registerDirectory', input);
},
select(
projectId: string | null,
host?: DesktopRuntimeHostRef,
Expand Down
Loading
Loading