mirror of
https://github.com/mountain-loop/yaak.git
synced 2026-08-17 09:02:05 +02:00
Compare commits
6
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c14f6ff3bb | ||
|
|
7d83b5cf3a | ||
|
|
bc27e5eee7 | ||
|
|
395959f84c | ||
|
|
b5b1ab4de8 | ||
|
|
e471d73c34 |
Generated
+1
@@ -11199,6 +11199,7 @@ dependencies = [
|
||||
"base64 0.22.1",
|
||||
"log 0.4.29",
|
||||
"md5 0.8.0",
|
||||
"rusqlite",
|
||||
"serde_json",
|
||||
"tempfile",
|
||||
"thiserror 2.0.17",
|
||||
|
||||
@@ -1,17 +1,28 @@
|
||||
import type { Folder, ImportDestination, ImportPlan, Workspace } from "@yaakapp-internal/models";
|
||||
import { HStack, Icon, VStack } from "@yaakapp-internal/ui";
|
||||
import { platform } from "@yaakapp-internal/platform";
|
||||
import { Icon, VStack } from "@yaakapp-internal/ui";
|
||||
import classNames from "classnames";
|
||||
import { useEffect, useRef, useState } from "react";
|
||||
import { useLocalStorage } from "react-use";
|
||||
import { pluralizeCount } from "../lib/pluralize";
|
||||
import { CommercialUseBanner } from "./CommercialUseBanner";
|
||||
import { Button } from "./core/Button";
|
||||
import { Checkbox } from "./core/Checkbox";
|
||||
import { PlainInput } from "./core/PlainInput";
|
||||
import { RadioCards } from "./core/RadioCards";
|
||||
|
||||
interface Props {
|
||||
importFile: (filePath: string) => Promise<void>;
|
||||
importUrl: (url: string) => Promise<void>;
|
||||
currentWorkspace: Workspace | null;
|
||||
selectedFolder: Folder | null;
|
||||
planFile: (filePath: string, destination: ImportDestination) => Promise<ImportPlan>;
|
||||
planUrl: (url: string, destination: ImportDestination) => Promise<ImportPlan>;
|
||||
commit: (plan: ImportPlan) => Promise<void>;
|
||||
cancel: () => void;
|
||||
onError: (err: unknown) => void;
|
||||
}
|
||||
|
||||
type DestinationChoice = "new_workspace" | "current_workspace";
|
||||
|
||||
/**
|
||||
* An absolute or relative path is unambiguously a file. Everything else is treated as a URL, so a
|
||||
* bare host like `example.com/openapi.json` still works (the backend defaults it to https).
|
||||
@@ -31,8 +42,21 @@ function fileName(path: string): string {
|
||||
return path.split(/[/\\]/).at(-1) || path;
|
||||
}
|
||||
|
||||
export function ImportDataDialog({ importFile, importUrl }: Props) {
|
||||
export function ImportDataDialog({
|
||||
currentWorkspace,
|
||||
selectedFolder,
|
||||
planFile,
|
||||
planUrl,
|
||||
commit,
|
||||
cancel,
|
||||
onError,
|
||||
}: Props) {
|
||||
const [isLoading, setIsLoading] = useState<boolean>(false);
|
||||
const [plan, setPlan] = useState<ImportPlan | null>(null);
|
||||
const [destinationChoice, setDestinationChoice] = useState<DestinationChoice>(
|
||||
currentWorkspace == null ? "new_workspace" : "current_workspace",
|
||||
);
|
||||
const [targetSelectedFolder, setTargetSelectedFolder] = useState(selectedFolder != null);
|
||||
// A file path or a URL. Both inputs write here, so there is only ever one thing to import
|
||||
const [source, setSource] = useLocalStorage<string | null>("importPathOrUrl", null);
|
||||
const [forceUpdateKey, setForceUpdateKey] = useState<number>(0);
|
||||
@@ -71,19 +95,110 @@ export function ImportDataDialog({ importFile, importUrl }: Props) {
|
||||
selectSource(selected);
|
||||
};
|
||||
|
||||
const handleImport = async () => {
|
||||
const destination = (): ImportDestination => {
|
||||
if (destinationChoice === "current_workspace" && currentWorkspace != null) {
|
||||
return {
|
||||
type: "current_workspace",
|
||||
workspaceId: currentWorkspace.id,
|
||||
folderId: targetSelectedFolder ? selectedFolder?.id : undefined,
|
||||
};
|
||||
}
|
||||
return { type: "new_workspace" };
|
||||
};
|
||||
|
||||
const handlePreview = async () => {
|
||||
setIsLoading(true);
|
||||
try {
|
||||
if (filePath != null) {
|
||||
await importFile(filePath);
|
||||
} else {
|
||||
await importUrl(trimmedSource);
|
||||
}
|
||||
const nextPlan =
|
||||
filePath != null
|
||||
? await planFile(filePath, destination())
|
||||
: await planUrl(trimmedSource, destination());
|
||||
setPlan(nextPlan);
|
||||
} catch (err) {
|
||||
onError(err);
|
||||
} finally {
|
||||
setIsLoading(false);
|
||||
}
|
||||
};
|
||||
|
||||
const handleCommit = async () => {
|
||||
if (plan == null) return;
|
||||
setIsLoading(true);
|
||||
try {
|
||||
await commit(plan);
|
||||
} catch (err) {
|
||||
onError(err);
|
||||
} finally {
|
||||
setIsLoading(false);
|
||||
}
|
||||
};
|
||||
|
||||
if (plan != null) {
|
||||
const counts = [
|
||||
["Workspace", plan.resources.workspaces.length],
|
||||
["Environment", plan.resources.environments.length],
|
||||
["Folder", plan.resources.folders.length],
|
||||
["HTTP Request", plan.resources.httpRequests.length],
|
||||
["gRPC Request", plan.resources.grpcRequests.length],
|
||||
["WebSocket Request", plan.resources.websocketRequests.length],
|
||||
] as const;
|
||||
const destinationLabel =
|
||||
plan.destination.type === "new_workspace"
|
||||
? "New workspace"
|
||||
: selectedFolder != null && plan.destination.folderId === selectedFolder.id
|
||||
? `${currentWorkspace?.name ?? "Current workspace"} / ${selectedFolder.name}`
|
||||
: (currentWorkspace?.name ?? "Current workspace");
|
||||
|
||||
return (
|
||||
<VStack space={4} className="pb-4">
|
||||
<div className="rounded-lg border border-border-subtle divide-y divide-border-subtle">
|
||||
<PreviewRow label="Detected format" value={plan.importer} />
|
||||
<PreviewRow label="Destination" value={destinationLabel} />
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<div className="text-sm font-semibold mb-1">Resources</div>
|
||||
<ul className="list-disc pl-6 text-sm text-text-subtle">
|
||||
{counts
|
||||
.filter(([, count]) => count > 0)
|
||||
.map(([label, count]) => (
|
||||
<li key={label}>{pluralizeCount(label, count)}</li>
|
||||
))}
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
{plan.warnings.length > 0 && (
|
||||
<div>
|
||||
<div className="text-sm font-semibold mb-1">Import details</div>
|
||||
<div className="rounded-lg border border-border-subtle divide-y divide-border-subtle">
|
||||
{plan.warnings.map((warning) => (
|
||||
<div
|
||||
key={`${warning.title}:${warning.detail}`}
|
||||
className="flex items-start gap-2.5 px-3 py-2.5"
|
||||
>
|
||||
<Icon icon="info" color="info" size="sm" className="mt-0.5" />
|
||||
<div className="min-w-0">
|
||||
<div className="text-sm font-medium">{warning.title}</div>
|
||||
<div className="text-xs text-text-subtle mt-0.5">{warning.detail}</div>
|
||||
</div>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
|
||||
<HStack space={2} justifyContent="end">
|
||||
<Button color="secondary" variant="border" disabled={isLoading} onClick={cancel}>
|
||||
Cancel
|
||||
</Button>
|
||||
<Button color="primary" isLoading={isLoading} onClick={handleCommit}>
|
||||
{isLoading ? "Importing" : "Confirm Import"}
|
||||
</Button>
|
||||
</HStack>
|
||||
</VStack>
|
||||
);
|
||||
}
|
||||
|
||||
return (
|
||||
<VStack ref={ref} space={4} className="pb-4">
|
||||
<CommercialUseBanner source="data-import" title="Importing work data?" />
|
||||
@@ -115,25 +230,69 @@ export function ImportDataDialog({ importFile, importUrl }: Props) {
|
||||
</div>
|
||||
</button>
|
||||
|
||||
<PlainInput
|
||||
label="Or enter a file path or URL"
|
||||
size="sm"
|
||||
placeholder="https://example.com/openapi.json"
|
||||
defaultValue={source ?? ""}
|
||||
forceUpdateKey={String(forceUpdateKey)}
|
||||
onChange={setSource}
|
||||
/>
|
||||
|
||||
<VStack space={2}>
|
||||
<PlainInput
|
||||
label="Or enter a file path or URL"
|
||||
size="sm"
|
||||
placeholder="https://example.com/openapi.json"
|
||||
defaultValue={source ?? ""}
|
||||
forceUpdateKey={String(forceUpdateKey)}
|
||||
onChange={setSource}
|
||||
<div className="text-sm font-semibold">Import destination</div>
|
||||
<RadioCards
|
||||
name="import-destination"
|
||||
value={destinationChoice}
|
||||
onChange={setDestinationChoice}
|
||||
options={[
|
||||
{
|
||||
value: "new_workspace",
|
||||
label: "New workspace",
|
||||
description: "Create imported resources in a separate workspace.",
|
||||
},
|
||||
...(currentWorkspace == null
|
||||
? []
|
||||
: [
|
||||
{
|
||||
value: "current_workspace" as const,
|
||||
label: currentWorkspace.name,
|
||||
description: "Add resources without changing this workspace's settings.",
|
||||
},
|
||||
]),
|
||||
]}
|
||||
/>
|
||||
{destinationChoice === "current_workspace" && selectedFolder != null && (
|
||||
<Checkbox
|
||||
checked={targetSelectedFolder}
|
||||
title={`Place root resources in selected folder “${selectedFolder.name}”`}
|
||||
onChange={setTargetSelectedFolder}
|
||||
/>
|
||||
)}
|
||||
</VStack>
|
||||
|
||||
<HStack space={2} justifyContent="end">
|
||||
<Button color="secondary" variant="border" disabled={isLoading} onClick={cancel}>
|
||||
Cancel
|
||||
</Button>
|
||||
<Button
|
||||
color="primary"
|
||||
disabled={trimmedSource === "" || isLoading}
|
||||
isLoading={isLoading}
|
||||
size="sm"
|
||||
onClick={handleImport}
|
||||
onClick={handlePreview}
|
||||
>
|
||||
{isLoading ? "Importing" : "Import"}
|
||||
{isLoading ? "Analyzing" : "Preview Import"}
|
||||
</Button>
|
||||
</VStack>
|
||||
</HStack>
|
||||
</VStack>
|
||||
);
|
||||
}
|
||||
|
||||
function PreviewRow({ label, value }: { label: string; value: string }) {
|
||||
return (
|
||||
<div className="flex items-start justify-between gap-4 px-3 py-2 text-sm">
|
||||
<span className="text-text-subtle">{label}</span>
|
||||
<span className="text-right font-medium">{value}</span>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -10,6 +10,7 @@ export interface DialogProps {
|
||||
children: ReactNode;
|
||||
open: boolean;
|
||||
onClose?: () => void;
|
||||
disableClose?: boolean;
|
||||
disableBackdropClose?: boolean;
|
||||
title?: ReactNode;
|
||||
description?: ReactNode;
|
||||
@@ -27,6 +28,7 @@ export function Dialog({
|
||||
size = "full",
|
||||
open,
|
||||
onClose,
|
||||
disableClose,
|
||||
disableBackdropClose,
|
||||
title,
|
||||
description,
|
||||
@@ -42,7 +44,11 @@ export function Dialog({
|
||||
);
|
||||
|
||||
return (
|
||||
<Overlay open={open} onClose={disableBackdropClose ? undefined : onClose} portalName="dialog">
|
||||
<Overlay
|
||||
open={open}
|
||||
onClose={disableClose || disableBackdropClose ? undefined : onClose}
|
||||
portalName="dialog"
|
||||
>
|
||||
<div
|
||||
role="dialog"
|
||||
className={classNames(
|
||||
@@ -58,7 +64,7 @@ export function Dialog({
|
||||
// NOTE: We handle Escape on the element itself so that it doesn't close multiple
|
||||
// dialogs and can be intercepted by children if needed.
|
||||
if (e.key === "Escape") {
|
||||
onClose?.();
|
||||
if (!disableClose) onClose?.();
|
||||
e.stopPropagation();
|
||||
e.preventDefault();
|
||||
}
|
||||
@@ -110,7 +116,7 @@ export function Dialog({
|
||||
</div>
|
||||
|
||||
{/*Put close at the end so that it's the last thing to be tabbed to*/}
|
||||
{!hideX && (
|
||||
{!hideX && !disableClose && (
|
||||
<div className="ml-auto absolute right-1 top-1">
|
||||
<IconButton
|
||||
className="opacity-70 hover:opacity-100"
|
||||
|
||||
@@ -1,10 +1,13 @@
|
||||
import type { BatchUpsertResult } from "@yaakapp-internal/models";
|
||||
import type { BatchUpsertResult, ImportDestination, ImportPlan } from "@yaakapp-internal/models";
|
||||
import { FormattedError, VStack } from "@yaakapp-internal/ui";
|
||||
import { Button } from "../components/core/Button";
|
||||
import { ImportDataDialog } from "../components/ImportDataDialog";
|
||||
import { activeFolderAtom } from "../hooks/useActiveFolder";
|
||||
import { activeWorkspaceAtom } from "../hooks/useActiveWorkspace";
|
||||
import { createFastMutation } from "../hooks/useFastMutation";
|
||||
import { showAlert } from "./alert";
|
||||
import { showDialog } from "./dialog";
|
||||
import { jotaiStore } from "./jotai";
|
||||
import { pluralizeCount } from "./pluralize";
|
||||
import { router } from "./router";
|
||||
import { rpc } from "./rpc";
|
||||
@@ -21,29 +24,41 @@ export const importData = createFastMutation({
|
||||
},
|
||||
mutationFn: async () => {
|
||||
return new Promise<void>((resolve, reject) => {
|
||||
const currentWorkspace = jotaiStore.get(activeWorkspaceAtom);
|
||||
const selectedFolder = jotaiStore.get(activeFolderAtom);
|
||||
showDialog({
|
||||
id: "import",
|
||||
title: "Import Data",
|
||||
size: "sm",
|
||||
disableClose: true,
|
||||
render: ({ hide }) => {
|
||||
const importAndHide = async (runImport: () => Promise<BatchUpsertResult>) => {
|
||||
try {
|
||||
await finishImport(await runImport());
|
||||
resolve();
|
||||
} catch (err) {
|
||||
reject(err);
|
||||
} finally {
|
||||
hide();
|
||||
}
|
||||
const cancel = () => {
|
||||
hide();
|
||||
resolve();
|
||||
};
|
||||
const fail = (err: unknown) => {
|
||||
hide();
|
||||
reject(err);
|
||||
};
|
||||
const commit = async (plan: ImportPlan) => {
|
||||
const imported = await rpc<BatchUpsertResult>("cmd_commit_import", { plan });
|
||||
hide();
|
||||
await finishImport(imported);
|
||||
resolve();
|
||||
};
|
||||
return (
|
||||
<ImportDataDialog
|
||||
importFile={(filePath) =>
|
||||
importAndHide(() => rpc<BatchUpsertResult>("cmd_import_data", { filePath }))
|
||||
currentWorkspace={currentWorkspace}
|
||||
selectedFolder={selectedFolder}
|
||||
planFile={(filePath: string, destination: ImportDestination) =>
|
||||
rpc<ImportPlan>("cmd_import_data", { filePath, destination })
|
||||
}
|
||||
importUrl={(url) =>
|
||||
importAndHide(() => rpc<BatchUpsertResult>("cmd_import_url", { url }))
|
||||
planUrl={(url: string, destination: ImportDestination) =>
|
||||
rpc<ImportPlan>("cmd_import_url", { url, destination })
|
||||
}
|
||||
commit={commit}
|
||||
cancel={cancel}
|
||||
onError={fail}
|
||||
/>
|
||||
);
|
||||
},
|
||||
|
||||
@@ -5,8 +5,7 @@ use std::fs;
|
||||
use std::io::ErrorKind;
|
||||
use yaak::export::{self, ExportDataParams};
|
||||
use yaak::import;
|
||||
use yaak_core::WorkspaceContext;
|
||||
use yaak_models::util::BatchUpsertResult;
|
||||
use yaak_models::util::{BatchUpsertResult, ImportDestination};
|
||||
use yaak_plugins::events::{ImportResources, PluginContext};
|
||||
|
||||
type CommandResult<T = ()> = std::result::Result<T, String>;
|
||||
@@ -51,6 +50,7 @@ async fn import(ctx: &CliContext, args: ImportArgs) -> CommandResult<BatchUpsert
|
||||
.import_data(&plugin_context, &file_contents)
|
||||
.await
|
||||
.map_err(|e| format!("Failed to import data: {e}"))?;
|
||||
let importer = import_result.importer;
|
||||
let resources = import_result.resources;
|
||||
let workspace_id = args.workspace_id;
|
||||
if workspace_id.is_none() && resources_need_current_workspace(&resources) {
|
||||
@@ -59,13 +59,13 @@ async fn import(ctx: &CliContext, args: ImportArgs) -> CommandResult<BatchUpsert
|
||||
.to_string(),
|
||||
);
|
||||
}
|
||||
let workspace_context = WorkspaceContext {
|
||||
workspace_id,
|
||||
environment_id: None,
|
||||
cookie_jar_id: None,
|
||||
request_id: None,
|
||||
let destination = match workspace_id {
|
||||
Some(workspace_id) => ImportDestination::CurrentWorkspace { workspace_id, folder_id: None },
|
||||
None => ImportDestination::NewWorkspace,
|
||||
};
|
||||
let imported = import::import_resources(ctx.query_manager(), workspace_context, resources)
|
||||
let plan = import::plan_import_resources(ctx.query_manager(), importer, destination, resources)
|
||||
.map_err(|e| format!("Failed to plan import: {e}"))?;
|
||||
let imported = import::commit_import_plan(ctx.query_manager(), plan)
|
||||
.map_err(|e| format!("Failed to import data: {e}"))?;
|
||||
Ok(imported)
|
||||
}
|
||||
|
||||
@@ -81,14 +81,21 @@ fn import_reads_yaak_workspace_file() {
|
||||
|
||||
let query_manager = query_manager(data_dir);
|
||||
let db = query_manager.connect();
|
||||
assert_eq!(
|
||||
db.get_workspace("wrk_import").expect("workspace imported").name,
|
||||
"Imported Workspace"
|
||||
);
|
||||
assert_eq!(
|
||||
db.get_http_request("req_import").expect("request imported").url,
|
||||
"https://example.com"
|
||||
);
|
||||
let workspaces = db.list_workspaces().expect("list imported workspaces");
|
||||
let workspace = workspaces
|
||||
.iter()
|
||||
.find(|workspace| workspace.name == "Imported Workspace")
|
||||
.expect("workspace imported");
|
||||
assert_ne!(workspace.id, "wrk_import");
|
||||
|
||||
let requests = db.list_http_requests(&workspace.id).expect("list imported requests");
|
||||
let request = requests
|
||||
.iter()
|
||||
.find(|request| request.name == "Imported Request")
|
||||
.expect("request imported");
|
||||
assert_ne!(request.id, "req_import");
|
||||
assert_eq!(request.workspace_id, workspace.id);
|
||||
assert_eq!(request.url, "https://example.com");
|
||||
}
|
||||
|
||||
fn write_postman_environment_fixture(path: &std::path::Path) {
|
||||
|
||||
@@ -4,53 +4,63 @@ use crate::models_ext::QueryManagerExt;
|
||||
use std::fs::read_to_string;
|
||||
use std::io::ErrorKind;
|
||||
use tauri::{Manager, Runtime, WebviewWindow};
|
||||
use yaak::import::{self, ImportDataParams};
|
||||
use yaak::import::{self, PlanImportDataParams};
|
||||
use yaak_api::{ApiClientKind, yaak_api_client};
|
||||
use yaak_core::WorkspaceContext;
|
||||
use yaak_models::util::BatchUpsertResult;
|
||||
use yaak_models::util::{BatchUpsertResult, ImportDestination, ImportPlan};
|
||||
use yaak_plugins::manager::PluginManager;
|
||||
use yaak_tauri_utils::window::WorkspaceWindowTrait;
|
||||
|
||||
pub(crate) async fn import_data<R: Runtime>(
|
||||
window: &WebviewWindow<R>,
|
||||
file_path: &str,
|
||||
) -> Result<BatchUpsertResult> {
|
||||
let contents = read_import_file(file_path)?;
|
||||
import_contents(window, &contents).await
|
||||
let plan = plan_import_data(window, file_path, ImportDestination::NewWorkspace).await?;
|
||||
commit_import(window, plan)
|
||||
}
|
||||
|
||||
pub(crate) async fn import_url<R: Runtime>(
|
||||
pub(crate) async fn plan_import_data<R: Runtime>(
|
||||
window: &WebviewWindow<R>,
|
||||
file_path: &str,
|
||||
destination: ImportDestination,
|
||||
) -> Result<ImportPlan> {
|
||||
let contents = read_import_file(file_path)?;
|
||||
plan_import_contents(window, &contents, destination).await
|
||||
}
|
||||
|
||||
pub(crate) async fn plan_import_url<R: Runtime>(
|
||||
window: &WebviewWindow<R>,
|
||||
url: &str,
|
||||
) -> Result<BatchUpsertResult> {
|
||||
destination: ImportDestination,
|
||||
) -> Result<ImportPlan> {
|
||||
let contents = fetch_import_url(window, url).await?;
|
||||
import_contents(window, &contents).await
|
||||
plan_import_contents(window, &contents, destination).await
|
||||
}
|
||||
|
||||
async fn import_contents<R: Runtime>(
|
||||
async fn plan_import_contents<R: Runtime>(
|
||||
window: &WebviewWindow<R>,
|
||||
contents: &str,
|
||||
) -> Result<BatchUpsertResult> {
|
||||
destination: ImportDestination,
|
||||
) -> Result<ImportPlan> {
|
||||
let plugin_manager = window.state::<PluginManager>();
|
||||
let query_manager = window.db_manager();
|
||||
let plugin_context = window.plugin_context();
|
||||
let workspace_context = WorkspaceContext {
|
||||
workspace_id: window.workspace_id(),
|
||||
environment_id: window.environment_id(),
|
||||
cookie_jar_id: window.cookie_jar_id(),
|
||||
request_id: None,
|
||||
};
|
||||
|
||||
Ok(import::import_data(ImportDataParams {
|
||||
Ok(import::plan_import_data(PlanImportDataParams {
|
||||
query_manager: &query_manager,
|
||||
plugin_manager: &plugin_manager,
|
||||
plugin_context: &plugin_context,
|
||||
workspace_context,
|
||||
destination,
|
||||
contents,
|
||||
})
|
||||
.await?)
|
||||
}
|
||||
|
||||
pub(crate) fn commit_import<R: Runtime>(
|
||||
window: &WebviewWindow<R>,
|
||||
plan: ImportPlan,
|
||||
) -> Result<BatchUpsertResult> {
|
||||
Ok(import::commit_import_plan(&window.db_manager(), plan)?)
|
||||
}
|
||||
|
||||
/// Download an importable document (OpenAPI, Postman, Insomnia, …) so it can be fed to the same
|
||||
/// pipeline as a file on disk.
|
||||
///
|
||||
|
||||
@@ -4,7 +4,7 @@ use crate::error::Error::GenericError;
|
||||
use crate::error::Result;
|
||||
use crate::grpc::{build_metadata, metadata_to_map};
|
||||
use crate::http_request::send_http_request;
|
||||
use crate::import::{import_data, import_url};
|
||||
use crate::import::{commit_import, plan_import_data, plan_import_url};
|
||||
use crate::models_ext::{BlobManagerExt, QueryManagerExt};
|
||||
use crate::notifications::YaakNotifier;
|
||||
use crate::render::{render_grpc_request, render_template};
|
||||
@@ -40,7 +40,7 @@ use yaak_models::models::{
|
||||
CookieJar, Environment, GrpcConnection, GrpcConnectionState, GrpcEvent,
|
||||
GrpcEventType, HttpRequest, HttpResponse, HttpResponseState, Workspace,
|
||||
};
|
||||
use yaak_models::util::{BatchUpsertResult, UpdateSource};
|
||||
use yaak_models::util::{BatchUpsertResult, ImportDestination, ImportPlan, UpdateSource};
|
||||
use yaak_plugins::events::{
|
||||
Color, ErrorResponse, FilterResponse, InternalEvent, InternalEventPayload, PluginContext,
|
||||
RenderPurpose, ShowToastRequest,
|
||||
@@ -1013,15 +1013,24 @@ async fn cmd_get_sse_events<R: Runtime>(
|
||||
async fn cmd_import_data<R: Runtime>(
|
||||
window: WebviewWindow<R>,
|
||||
file_path: &str,
|
||||
) -> YaakResult<BatchUpsertResult> {
|
||||
import_data(&window, file_path).await
|
||||
destination: ImportDestination,
|
||||
) -> YaakResult<ImportPlan> {
|
||||
plan_import_data(&window, file_path, destination).await
|
||||
}
|
||||
|
||||
async fn cmd_import_url<R: Runtime>(
|
||||
window: WebviewWindow<R>,
|
||||
url: &str,
|
||||
destination: ImportDestination,
|
||||
) -> YaakResult<ImportPlan> {
|
||||
plan_import_url(&window, url, destination).await
|
||||
}
|
||||
|
||||
async fn cmd_commit_import<R: Runtime>(
|
||||
window: WebviewWindow<R>,
|
||||
plan: ImportPlan,
|
||||
) -> YaakResult<BatchUpsertResult> {
|
||||
import_url(&window, url).await
|
||||
commit_import(&window, plan)
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -40,7 +40,7 @@ use yaak_models::models::{
|
||||
HttpResponseEvent, Plugin, Settings, WebsocketConnection, WebsocketEvent, WorkspaceMeta,
|
||||
};
|
||||
use yaak_models::query_manager::QueryManager;
|
||||
use yaak_models::util::BatchUpsertResult;
|
||||
use yaak_models::util::{BatchUpsertResult, ImportPlan};
|
||||
use yaak_plugins::events::{
|
||||
CallFolderActionRequest, CallGrpcRequestActionRequest, CallHttpRequestActionRequest,
|
||||
CallWebsocketRequestActionRequest, CallWorkspaceActionRequest, FilterResponse, ImportResponse,
|
||||
@@ -441,12 +441,16 @@ async fn cmd_get_http_response_events<R: Runtime>(ctx: ClientCtx<R>, req: CmdGet
|
||||
Ok(yaak_commands::responses::cmd_get_http_response_events(ctx, req).await?)
|
||||
}
|
||||
|
||||
async fn cmd_import_data<R: Runtime>(ctx: ClientCtx<R>, req: CmdImportDataReq) -> Result<BatchUpsertResult> {
|
||||
Ok(crate::cmd_import_data(ctx.window.clone(), &req.file_path).await?)
|
||||
async fn cmd_import_data<R: Runtime>(ctx: ClientCtx<R>, req: CmdImportDataReq) -> Result<ImportPlan> {
|
||||
Ok(crate::cmd_import_data(ctx.window.clone(), &req.file_path, req.destination).await?)
|
||||
}
|
||||
|
||||
async fn cmd_import_url<R: Runtime>(ctx: ClientCtx<R>, req: CmdImportUrlReq) -> Result<BatchUpsertResult> {
|
||||
Ok(crate::cmd_import_url(ctx.window.clone(), &req.url).await?)
|
||||
async fn cmd_import_url<R: Runtime>(ctx: ClientCtx<R>, req: CmdImportUrlReq) -> Result<ImportPlan> {
|
||||
Ok(crate::cmd_import_url(ctx.window.clone(), &req.url, req.destination).await?)
|
||||
}
|
||||
|
||||
async fn cmd_commit_import<R: Runtime>(ctx: ClientCtx<R>, req: CmdCommitImportReq) -> Result<BatchUpsertResult> {
|
||||
Ok(crate::cmd_commit_import(ctx.window.clone(), req.plan).await?)
|
||||
}
|
||||
|
||||
async fn cmd_http_request_actions<R: Runtime>(ctx: ClientCtx<R>, req: CmdHttpRequestActionsReq) -> Result<Vec<GetHttpRequestActionsResponse>> {
|
||||
@@ -843,4 +847,3 @@ async fn cmd_plugins_updates<R: Runtime>(ctx: ClientCtx<R>, _req: CmdPluginsUpda
|
||||
async fn cmd_plugins_update_all<R: Runtime>(ctx: ClientCtx<R>, _req: CmdPluginsUpdateAllReq) -> Result<Vec<PluginNameVersion>> {
|
||||
Ok(crate::plugins_ext::cmd_plugins_update_all(ctx.window.clone()).await?)
|
||||
}
|
||||
|
||||
|
||||
+6
-4
File diff suppressed because one or more lines are too long
+10
@@ -2,3 +2,13 @@
|
||||
import type { Environment, Folder, GrpcRequest, HttpRequest, WebsocketRequest, Workspace } from "./gen_models";
|
||||
|
||||
export type BatchUpsertResult = { workspaces: Array<Workspace>, environments: Array<Environment>, folders: Array<Folder>, httpRequests: Array<HttpRequest>, grpcRequests: Array<GrpcRequest>, websocketRequests: Array<WebsocketRequest>, };
|
||||
|
||||
export type ImportDestination = { "type": "new_workspace" } | { "type": "current_workspace", workspaceId: string, folderId?: string, };
|
||||
|
||||
export type ImportPlan = { importer: string, destination: ImportDestination, resources: ImportPlanResources, warnings: Array<ImportPlanWarning>, };
|
||||
|
||||
export type ImportPlanWarning = { title: string, detail: string, };
|
||||
|
||||
export type ImportPlanResources = { workspaces: Array<PlannedImportResource<Workspace>>, environments: Array<PlannedImportResource<Environment>>, folders: Array<PlannedImportResource<Folder>>, httpRequests: Array<PlannedImportResource<HttpRequest>>, grpcRequests: Array<PlannedImportResource<GrpcRequest>>, websocketRequests: Array<PlannedImportResource<WebsocketRequest>>, };
|
||||
|
||||
export type PlannedImportResource<T> = { sourceKey?: string, resource: T, };
|
||||
|
||||
@@ -23,7 +23,7 @@ use yaak_models::models::{
|
||||
AnyModel, GraphQlIntrospection, GrpcEvent, HttpRequest, HttpRequestHeader, HttpResponse,
|
||||
HttpResponseEvent, Plugin, Settings, WebsocketConnection, WebsocketEvent, WorkspaceMeta,
|
||||
};
|
||||
use yaak_models::util::BatchUpsertResult;
|
||||
use yaak_models::util::{BatchUpsertResult, ImportDestination, ImportPlan};
|
||||
use yaak_plugins::api::{PluginNameVersion, PluginSearchResponse, PluginUpdatesResponse};
|
||||
use yaak_plugins::events::{
|
||||
CallFolderActionRequest, CallGrpcRequestActionRequest, CallHttpRequestActionRequest,
|
||||
@@ -229,6 +229,7 @@ pub struct CmdGetHttpResponseEventsReq {
|
||||
#[ts(export, export_to = "gen_rpc.ts")]
|
||||
pub struct CmdImportDataReq {
|
||||
pub file_path: String,
|
||||
pub destination: ImportDestination,
|
||||
}
|
||||
|
||||
#[derive(Debug, Deserialize, TS)]
|
||||
@@ -236,6 +237,14 @@ pub struct CmdImportDataReq {
|
||||
#[ts(export, export_to = "gen_rpc.ts")]
|
||||
pub struct CmdImportUrlReq {
|
||||
pub url: String,
|
||||
pub destination: ImportDestination,
|
||||
}
|
||||
|
||||
#[derive(Debug, Deserialize, TS)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[ts(export, export_to = "gen_rpc.ts")]
|
||||
pub struct CmdCommitImportReq {
|
||||
pub plan: ImportPlan,
|
||||
}
|
||||
|
||||
#[derive(Debug, Deserialize, TS)]
|
||||
@@ -909,8 +918,9 @@ macro_rules! with_commands {
|
||||
cmd_http_request_body(CmdHttpRequestBodyReq) -> Option<Vec<u8>>,
|
||||
cmd_get_sse_events(CmdGetSseEventsReq) -> Vec<ServerSentEvent>,
|
||||
cmd_get_http_response_events(CmdGetHttpResponseEventsReq) -> Vec<HttpResponseEvent>,
|
||||
cmd_import_data(CmdImportDataReq) -> BatchUpsertResult,
|
||||
cmd_import_url(CmdImportUrlReq) -> BatchUpsertResult,
|
||||
cmd_import_data(CmdImportDataReq) -> ImportPlan,
|
||||
cmd_import_url(CmdImportUrlReq) -> ImportPlan,
|
||||
cmd_commit_import(CmdCommitImportReq) -> BatchUpsertResult,
|
||||
cmd_http_request_actions(CmdHttpRequestActionsReq) -> Vec<GetHttpRequestActionsResponse>,
|
||||
cmd_websocket_request_actions(CmdWebsocketRequestActionsReq) -> Vec<GetWebsocketRequestActionsResponse>,
|
||||
cmd_call_websocket_request_action(CmdCallWebsocketRequestActionReq) -> (),
|
||||
|
||||
Generated
+10
@@ -2,3 +2,13 @@
|
||||
import type { Environment, Folder, GrpcRequest, HttpRequest, WebsocketRequest, Workspace } from "./gen_models";
|
||||
|
||||
export type BatchUpsertResult = { workspaces: Array<Workspace>, environments: Array<Environment>, folders: Array<Folder>, httpRequests: Array<HttpRequest>, grpcRequests: Array<GrpcRequest>, websocketRequests: Array<WebsocketRequest>, };
|
||||
|
||||
export type ImportDestination = { "type": "new_workspace" } | { "type": "current_workspace", workspaceId: string, folderId?: string, };
|
||||
|
||||
export type ImportPlan = { importer: string, destination: ImportDestination, resources: ImportPlanResources, warnings: Array<ImportPlanWarning>, };
|
||||
|
||||
export type ImportPlanWarning = { title: string, detail: string, };
|
||||
|
||||
export type ImportPlanResources = { workspaces: Array<PlannedImportResource<Workspace>>, environments: Array<PlannedImportResource<Environment>>, folders: Array<PlannedImportResource<Folder>>, httpRequests: Array<PlannedImportResource<HttpRequest>>, grpcRequests: Array<PlannedImportResource<GrpcRequest>>, websocketRequests: Array<PlannedImportResource<WebsocketRequest>>, };
|
||||
|
||||
export type PlannedImportResource<T> = { sourceKey?: string, resource: T, };
|
||||
|
||||
@@ -85,6 +85,86 @@ pub struct BatchUpsertResult {
|
||||
pub websocket_requests: Vec<WebsocketRequest>,
|
||||
}
|
||||
|
||||
/// Where a staged import will be committed.
|
||||
///
|
||||
/// The current workspace and optional folder IDs are captured in the plan so the preview describes
|
||||
/// the exact destination that confirmation will use.
|
||||
#[derive(Debug, Clone, Deserialize, Serialize, TS)]
|
||||
#[serde(rename_all = "snake_case", tag = "type")]
|
||||
#[ts(export, export_to = "gen_util.ts")]
|
||||
pub enum ImportDestination {
|
||||
NewWorkspace,
|
||||
CurrentWorkspace {
|
||||
#[serde(rename = "workspaceId")]
|
||||
workspace_id: String,
|
||||
#[serde(rename = "folderId")]
|
||||
#[ts(optional)]
|
||||
folder_id: Option<String>,
|
||||
},
|
||||
}
|
||||
|
||||
/// A model staged for import.
|
||||
///
|
||||
/// `source_key` is intentionally part of the plan boundary even though the first import slice does
|
||||
/// not persist it. Future linked imports can populate it without changing how plans contain models.
|
||||
#[derive(Debug, Clone, Deserialize, Serialize, TS)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[ts(export, export_to = "gen_util.ts")]
|
||||
pub struct PlannedImportResource<T> {
|
||||
#[ts(optional)]
|
||||
pub source_key: Option<String>,
|
||||
pub resource: T,
|
||||
}
|
||||
|
||||
impl<T> PlannedImportResource<T> {
|
||||
pub fn new(resource: T) -> Self {
|
||||
Self { source_key: None, resource }
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Default, Debug, Clone, Deserialize, Serialize, TS)]
|
||||
#[serde(default, rename_all = "camelCase")]
|
||||
#[ts(export, export_to = "gen_util.ts")]
|
||||
pub struct ImportPlanResources {
|
||||
pub workspaces: Vec<PlannedImportResource<Workspace>>,
|
||||
pub environments: Vec<PlannedImportResource<Environment>>,
|
||||
pub folders: Vec<PlannedImportResource<Folder>>,
|
||||
pub http_requests: Vec<PlannedImportResource<HttpRequest>>,
|
||||
pub grpc_requests: Vec<PlannedImportResource<GrpcRequest>>,
|
||||
pub websocket_requests: Vec<PlannedImportResource<WebsocketRequest>>,
|
||||
}
|
||||
|
||||
impl ImportPlanResources {
|
||||
pub fn into_batch(self) -> BatchUpsertResult {
|
||||
BatchUpsertResult {
|
||||
workspaces: self.workspaces.into_iter().map(|v| v.resource).collect(),
|
||||
environments: self.environments.into_iter().map(|v| v.resource).collect(),
|
||||
folders: self.folders.into_iter().map(|v| v.resource).collect(),
|
||||
http_requests: self.http_requests.into_iter().map(|v| v.resource).collect(),
|
||||
grpc_requests: self.grpc_requests.into_iter().map(|v| v.resource).collect(),
|
||||
websocket_requests: self.websocket_requests.into_iter().map(|v| v.resource).collect(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Deserialize, Serialize, TS)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[ts(export, export_to = "gen_util.ts")]
|
||||
pub struct ImportPlanWarning {
|
||||
pub title: String,
|
||||
pub detail: String,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Deserialize, Serialize, TS)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[ts(export, export_to = "gen_util.ts")]
|
||||
pub struct ImportPlan {
|
||||
pub importer: String,
|
||||
pub destination: ImportDestination,
|
||||
pub resources: ImportPlanResources,
|
||||
pub warnings: Vec<ImportPlanWarning>,
|
||||
}
|
||||
|
||||
pub fn get_workspace_export_resources(
|
||||
db: &ClientDb,
|
||||
yaak_version: &str,
|
||||
|
||||
+1
-1
@@ -474,7 +474,7 @@ export type ImportRequest = { content: string, };
|
||||
|
||||
export type ImportResources = { workspaces: Array<Workspace>, environments: Array<Environment>, folders: Array<Folder>, httpRequests: Array<HttpRequest>, grpcRequests: Array<GrpcRequest>, websocketRequests: Array<WebsocketRequest>, };
|
||||
|
||||
export type ImportResponse = { resources: ImportResources, };
|
||||
export type ImportResponse = { importer: string, resources: ImportResources, };
|
||||
|
||||
export type InternalEvent = { id: string, pluginRefId: string, pluginName: string, replyId: string | null, context: PluginContext, payload: InternalEventPayload, };
|
||||
|
||||
|
||||
@@ -247,6 +247,8 @@ pub struct ImportRequest {
|
||||
#[serde(default, rename_all = "camelCase")]
|
||||
#[ts(export, export_to = "gen_events.ts")]
|
||||
pub struct ImportResponse {
|
||||
/// Display name of the importer that recognized the input.
|
||||
pub importer: String,
|
||||
pub resources: ImportResources,
|
||||
}
|
||||
|
||||
|
||||
@@ -1104,8 +1104,19 @@ impl PluginManager {
|
||||
.await?;
|
||||
|
||||
// TODO: Don't just return the first valid response
|
||||
let result = reply_events.into_iter().find_map(|e| match e.payload {
|
||||
InternalEventPayload::ImportResponse(resp) => Some(resp),
|
||||
let result = reply_events.into_iter().find_map(|e| match e {
|
||||
InternalEvent {
|
||||
plugin_name,
|
||||
payload: InternalEventPayload::ImportResponse(mut resp),
|
||||
..
|
||||
} => {
|
||||
// Older plugin runtimes do not include the importer's display name. The plugin
|
||||
// package name is still enough to identify the detected format in that case.
|
||||
if resp.importer.is_empty() {
|
||||
resp.importer = plugin_name;
|
||||
}
|
||||
Some(resp)
|
||||
}
|
||||
_ => None,
|
||||
});
|
||||
|
||||
|
||||
@@ -21,5 +21,6 @@ yaak-templates = { workspace = true }
|
||||
yaak-tls = { workspace = true }
|
||||
|
||||
[dev-dependencies]
|
||||
rusqlite = { version = "0.38", features = ["bundled"] }
|
||||
tempfile = "3"
|
||||
tokio = { workspace = true, features = ["macros", "rt-multi-thread"] }
|
||||
|
||||
+770
-73
@@ -1,129 +1,826 @@
|
||||
use crate::Result;
|
||||
use log::info;
|
||||
use std::collections::BTreeMap;
|
||||
use yaak_core::WorkspaceContext;
|
||||
use std::collections::{BTreeMap, BTreeSet};
|
||||
use yaak_models::client_db::ClientDb;
|
||||
use yaak_models::models::{
|
||||
Environment, Folder, GrpcRequest, HttpRequest, WebsocketRequest, Workspace,
|
||||
DEFAULT_REQUEST_MESSAGE_SIZE, Environment, Folder, GrpcRequest, HttpRequest, UpsertModelInfo,
|
||||
WebsocketRequest, Workspace,
|
||||
};
|
||||
use yaak_models::query_manager::QueryManager;
|
||||
use yaak_models::util::{BatchUpsertResult, UpdateSource, maybe_gen_id, maybe_gen_id_opt};
|
||||
use yaak_models::util::{
|
||||
BatchUpsertResult, ImportDestination, ImportPlan, ImportPlanResources, ImportPlanWarning,
|
||||
PlannedImportResource, UpdateSource,
|
||||
};
|
||||
use yaak_plugins::events::{ImportResources, PluginContext};
|
||||
use yaak_plugins::manager::PluginManager;
|
||||
|
||||
pub struct ImportDataParams<'a> {
|
||||
pub struct PlanImportDataParams<'a> {
|
||||
pub query_manager: &'a QueryManager,
|
||||
pub plugin_manager: &'a PluginManager,
|
||||
pub plugin_context: &'a PluginContext,
|
||||
pub workspace_context: WorkspaceContext,
|
||||
pub destination: ImportDestination,
|
||||
pub contents: &'a str,
|
||||
}
|
||||
|
||||
pub async fn import_data(params: ImportDataParams<'_>) -> Result<BatchUpsertResult> {
|
||||
/// Parse importer output and turn it into a commit-ready plan without mutating the database.
|
||||
pub async fn plan_import_data(params: PlanImportDataParams<'_>) -> Result<ImportPlan> {
|
||||
let import_result =
|
||||
params.plugin_manager.import_data(params.plugin_context, params.contents).await?;
|
||||
|
||||
import_resources(params.query_manager, params.workspace_context, import_result.resources)
|
||||
plan_import_resources(
|
||||
params.query_manager,
|
||||
import_result.importer,
|
||||
params.destination,
|
||||
import_result.resources,
|
||||
)
|
||||
}
|
||||
|
||||
pub fn import_resources(
|
||||
/// Remap parsed importer resources into their selected destination.
|
||||
///
|
||||
/// Every imported model gets a fresh ID. This prevents an import from accidentally updating an
|
||||
/// existing model and also makes the plan safe to inspect before it is committed.
|
||||
pub fn plan_import_resources(
|
||||
query_manager: &QueryManager,
|
||||
workspace_context: WorkspaceContext,
|
||||
importer: String,
|
||||
destination: ImportDestination,
|
||||
resources: ImportResources,
|
||||
) -> Result<BatchUpsertResult> {
|
||||
let mut id_map: BTreeMap<String, String> = BTreeMap::new();
|
||||
) -> Result<ImportPlan> {
|
||||
let mut warnings = Vec::new();
|
||||
validate_destination(query_manager, &destination)?;
|
||||
|
||||
let workspaces: Vec<Workspace> = resources
|
||||
.workspaces
|
||||
.into_iter()
|
||||
.map(|mut v| {
|
||||
v.id = maybe_gen_id::<Workspace>(&workspace_context, v.id.as_str(), &mut id_map);
|
||||
v
|
||||
})
|
||||
.collect();
|
||||
let source_folder_ids = resources.folders.iter().map(|v| v.id.clone()).collect::<BTreeSet<_>>();
|
||||
let mut folder_ids = BTreeMap::new();
|
||||
for folder in &resources.folders {
|
||||
folder_ids.insert(folder.id.clone(), Folder::generate_id());
|
||||
}
|
||||
|
||||
let environments: Vec<Environment> = resources
|
||||
.environments
|
||||
.into_iter()
|
||||
.map(|mut v| {
|
||||
v.id = maybe_gen_id::<Environment>(&workspace_context, v.id.as_str(), &mut id_map);
|
||||
v.workspace_id =
|
||||
maybe_gen_id::<Workspace>(&workspace_context, v.workspace_id.as_str(), &mut id_map);
|
||||
match (v.parent_model.as_str(), v.parent_id.clone().as_deref()) {
|
||||
("folder", Some(parent_id)) => {
|
||||
v.parent_id =
|
||||
Some(maybe_gen_id::<Folder>(&workspace_context, parent_id, &mut id_map));
|
||||
}
|
||||
("", _) => {
|
||||
v.parent_model = "workspace".to_string();
|
||||
}
|
||||
_ => {
|
||||
v.parent_id = None;
|
||||
}
|
||||
};
|
||||
v
|
||||
})
|
||||
.collect();
|
||||
let mut workspace_ids = BTreeMap::new();
|
||||
let mut workspaces = Vec::new();
|
||||
let (default_workspace_id, target_folder_id) = match &destination {
|
||||
ImportDestination::NewWorkspace => {
|
||||
for source in &resources.workspaces {
|
||||
let mut workspace = source.clone();
|
||||
workspace.id = Workspace::generate_id();
|
||||
workspace_ids.insert(source.id.clone(), workspace.id.clone());
|
||||
workspaces.push(PlannedImportResource::new(workspace));
|
||||
}
|
||||
|
||||
let folders: Vec<Folder> = resources
|
||||
if workspaces.is_empty() {
|
||||
let workspace = Workspace {
|
||||
id: Workspace::generate_id(),
|
||||
model: "workspace".to_string(),
|
||||
name: format!("{} Import", display_importer_name(&importer)),
|
||||
setting_follow_redirects: true,
|
||||
setting_request_message_size: DEFAULT_REQUEST_MESSAGE_SIZE,
|
||||
setting_validate_certificates: true,
|
||||
setting_send_cookies: true,
|
||||
setting_store_cookies: true,
|
||||
..Default::default()
|
||||
};
|
||||
workspaces.push(PlannedImportResource::new(workspace));
|
||||
}
|
||||
|
||||
(workspaces[0].resource.id.clone(), None)
|
||||
}
|
||||
ImportDestination::CurrentWorkspace { workspace_id, folder_id } => {
|
||||
for source in &resources.workspaces {
|
||||
workspace_ids.insert(source.id.clone(), workspace_id.clone());
|
||||
}
|
||||
if !resources.workspaces.is_empty() {
|
||||
let destination_workspace = query_manager.connect().get_workspace(workspace_id)?;
|
||||
let skipped_fields = resources
|
||||
.workspaces
|
||||
.iter()
|
||||
.flat_map(|source| {
|
||||
workspace_fields_not_imported(source, &destination_workspace)
|
||||
})
|
||||
.collect::<BTreeSet<_>>();
|
||||
if !skipped_fields.is_empty() {
|
||||
let source = if resources.workspaces.len() == 1 {
|
||||
resources.workspaces[0].name.clone()
|
||||
} else {
|
||||
format!("{} imported workspaces", resources.workspaces.len())
|
||||
};
|
||||
warnings.push(ImportPlanWarning {
|
||||
title: "Workspace settings skipped".to_string(),
|
||||
detail: format!("{source} · {}", display_list(&skipped_fields)),
|
||||
});
|
||||
}
|
||||
}
|
||||
(workspace_id.clone(), folder_id.clone())
|
||||
}
|
||||
};
|
||||
|
||||
let resolve_workspace_id = |source_id: &str| {
|
||||
workspace_ids.get(source_id).cloned().unwrap_or_else(|| default_workspace_id.clone())
|
||||
};
|
||||
|
||||
let resolve_folder_id = |source_id: Option<String>| match source_id {
|
||||
Some(source_id) if source_folder_ids.contains(&source_id) => {
|
||||
folder_ids.get(&source_id).cloned()
|
||||
}
|
||||
_ => target_folder_id.clone(),
|
||||
};
|
||||
|
||||
let folders = resources
|
||||
.folders
|
||||
.into_iter()
|
||||
.map(|mut v| {
|
||||
v.id = maybe_gen_id::<Folder>(&workspace_context, v.id.as_str(), &mut id_map);
|
||||
v.workspace_id =
|
||||
maybe_gen_id::<Workspace>(&workspace_context, v.workspace_id.as_str(), &mut id_map);
|
||||
v.folder_id = maybe_gen_id_opt::<Folder>(&workspace_context, v.folder_id, &mut id_map);
|
||||
v
|
||||
.map(|mut folder| {
|
||||
folder.id = folder_ids.get(&folder.id).cloned().unwrap_or_else(Folder::generate_id);
|
||||
folder.workspace_id = resolve_workspace_id(&folder.workspace_id);
|
||||
folder.folder_id = resolve_folder_id(folder.folder_id);
|
||||
PlannedImportResource::new(folder)
|
||||
})
|
||||
.collect();
|
||||
|
||||
let http_requests: Vec<HttpRequest> = resources
|
||||
let http_requests = resources
|
||||
.http_requests
|
||||
.into_iter()
|
||||
.map(|mut v| {
|
||||
v.id = maybe_gen_id::<HttpRequest>(&workspace_context, v.id.as_str(), &mut id_map);
|
||||
v.workspace_id =
|
||||
maybe_gen_id::<Workspace>(&workspace_context, v.workspace_id.as_str(), &mut id_map);
|
||||
v.folder_id = maybe_gen_id_opt::<Folder>(&workspace_context, v.folder_id, &mut id_map);
|
||||
v
|
||||
.map(|mut request| {
|
||||
request.id = HttpRequest::generate_id();
|
||||
request.workspace_id = resolve_workspace_id(&request.workspace_id);
|
||||
request.folder_id = resolve_folder_id(request.folder_id);
|
||||
PlannedImportResource::new(request)
|
||||
})
|
||||
.collect();
|
||||
|
||||
let grpc_requests: Vec<GrpcRequest> = resources
|
||||
let grpc_requests = resources
|
||||
.grpc_requests
|
||||
.into_iter()
|
||||
.map(|mut v| {
|
||||
v.id = maybe_gen_id::<GrpcRequest>(&workspace_context, v.id.as_str(), &mut id_map);
|
||||
v.workspace_id =
|
||||
maybe_gen_id::<Workspace>(&workspace_context, v.workspace_id.as_str(), &mut id_map);
|
||||
v.folder_id = maybe_gen_id_opt::<Folder>(&workspace_context, v.folder_id, &mut id_map);
|
||||
v
|
||||
.map(|mut request| {
|
||||
request.id = GrpcRequest::generate_id();
|
||||
request.workspace_id = resolve_workspace_id(&request.workspace_id);
|
||||
request.folder_id = resolve_folder_id(request.folder_id);
|
||||
PlannedImportResource::new(request)
|
||||
})
|
||||
.collect();
|
||||
|
||||
let websocket_requests: Vec<WebsocketRequest> = resources
|
||||
let websocket_requests = resources
|
||||
.websocket_requests
|
||||
.into_iter()
|
||||
.map(|mut v| {
|
||||
v.id = maybe_gen_id::<WebsocketRequest>(&workspace_context, v.id.as_str(), &mut id_map);
|
||||
v.workspace_id =
|
||||
maybe_gen_id::<Workspace>(&workspace_context, v.workspace_id.as_str(), &mut id_map);
|
||||
v.folder_id = maybe_gen_id_opt::<Folder>(&workspace_context, v.folder_id, &mut id_map);
|
||||
v
|
||||
.map(|mut request| {
|
||||
request.id = WebsocketRequest::generate_id();
|
||||
request.workspace_id = resolve_workspace_id(&request.workspace_id);
|
||||
request.folder_id = resolve_folder_id(request.folder_id);
|
||||
PlannedImportResource::new(request)
|
||||
})
|
||||
.collect();
|
||||
|
||||
info!("Importing data");
|
||||
let importing_into_current = matches!(destination, ImportDestination::CurrentWorkspace { .. });
|
||||
let mut separated_base_environments = Vec::new();
|
||||
let mut converted_duplicate_base_environment = false;
|
||||
let mut converted_duplicate_folder_environment = false;
|
||||
let mut base_environment_workspaces = BTreeSet::new();
|
||||
let mut folder_environment_ids = BTreeSet::new();
|
||||
let environments = resources
|
||||
.environments
|
||||
.into_iter()
|
||||
.map(|mut environment| {
|
||||
environment.id = Environment::generate_id();
|
||||
environment.workspace_id = resolve_workspace_id(&environment.workspace_id);
|
||||
|
||||
query_manager.with_tx(|tx| {
|
||||
tx.batch_upsert(
|
||||
match (environment.parent_model.as_str(), environment.parent_id.clone()) {
|
||||
("workspace", _) if importing_into_current => {
|
||||
environment.parent_model = "environment".to_string();
|
||||
environment.parent_id = None;
|
||||
let source_name = environment.name.clone();
|
||||
environment.name = format!("{} (Imported)", environment.name);
|
||||
separated_base_environments.push((
|
||||
source_name,
|
||||
environment.name.clone(),
|
||||
environment.variables.len(),
|
||||
));
|
||||
}
|
||||
("workspace", _) => {
|
||||
environment.parent_id = None;
|
||||
if !base_environment_workspaces.insert(environment.workspace_id.clone()) {
|
||||
environment.parent_model = "environment".to_string();
|
||||
environment.name = format!("{} (Imported)", environment.name);
|
||||
converted_duplicate_base_environment = true;
|
||||
}
|
||||
}
|
||||
("folder", Some(parent_id)) if source_folder_ids.contains(&parent_id) => {
|
||||
environment.parent_id = folder_ids.get(&parent_id).cloned();
|
||||
if let Some(parent_id) = &environment.parent_id
|
||||
&& !folder_environment_ids.insert(parent_id.clone())
|
||||
{
|
||||
environment.parent_model = "environment".to_string();
|
||||
environment.parent_id = None;
|
||||
converted_duplicate_folder_environment = true;
|
||||
}
|
||||
}
|
||||
("folder", _) => {
|
||||
// Never attach an imported folder environment to an existing folder: the model
|
||||
// layer permits only one and would otherwise delete the destination's value.
|
||||
environment.parent_model = "environment".to_string();
|
||||
environment.parent_id = None;
|
||||
}
|
||||
("environment", _) => {
|
||||
environment.parent_id = None;
|
||||
}
|
||||
_ => {
|
||||
environment.parent_model = "environment".to_string();
|
||||
environment.parent_id = None;
|
||||
}
|
||||
}
|
||||
|
||||
PlannedImportResource::new(environment)
|
||||
})
|
||||
.collect();
|
||||
|
||||
for (source_name, imported_name, variable_count) in separated_base_environments {
|
||||
let variables = if variable_count == 1 { "variable" } else { "variables" };
|
||||
warnings.push(ImportPlanWarning {
|
||||
title: "Base environment kept separate".to_string(),
|
||||
detail: format!("{source_name} → {imported_name} · {variable_count} {variables}"),
|
||||
});
|
||||
}
|
||||
if converted_duplicate_base_environment {
|
||||
warnings.push(ImportPlanWarning {
|
||||
title: "Base environments separated".to_string(),
|
||||
detail: "Only the first remains the base environment".to_string(),
|
||||
});
|
||||
}
|
||||
if converted_duplicate_folder_environment {
|
||||
warnings.push(ImportPlanWarning {
|
||||
title: "Folder environments separated".to_string(),
|
||||
detail: "Only the first remains attached to each folder".to_string(),
|
||||
});
|
||||
}
|
||||
|
||||
Ok(ImportPlan {
|
||||
importer,
|
||||
destination,
|
||||
resources: ImportPlanResources {
|
||||
workspaces,
|
||||
environments,
|
||||
folders,
|
||||
http_requests,
|
||||
grpc_requests,
|
||||
websocket_requests,
|
||||
},
|
||||
warnings,
|
||||
})
|
||||
}
|
||||
|
||||
/// Commit a previously prepared plan in one transaction.
|
||||
pub fn commit_import_plan(
|
||||
query_manager: &QueryManager,
|
||||
plan: ImportPlan,
|
||||
) -> Result<BatchUpsertResult> {
|
||||
validate_plan(&plan)?;
|
||||
let resources = plan.resources.into_batch();
|
||||
|
||||
info!("Committing staged import from {}", plan.importer);
|
||||
query_manager.with_tx(|tx| {
|
||||
validate_destination_db(tx, &plan.destination)?;
|
||||
tx.batch_upsert(
|
||||
resources.workspaces,
|
||||
resources.environments,
|
||||
resources.folders,
|
||||
resources.http_requests,
|
||||
resources.grpc_requests,
|
||||
resources.websocket_requests,
|
||||
&UpdateSource::Import,
|
||||
)
|
||||
.map_err(crate::Error::from)
|
||||
})
|
||||
}
|
||||
|
||||
fn validate_destination(
|
||||
query_manager: &QueryManager,
|
||||
destination: &ImportDestination,
|
||||
) -> Result<()> {
|
||||
let db = query_manager.connect();
|
||||
validate_destination_db(&db, destination)
|
||||
}
|
||||
|
||||
fn validate_destination_db(db: &ClientDb<'_>, destination: &ImportDestination) -> Result<()> {
|
||||
let ImportDestination::CurrentWorkspace { workspace_id, folder_id } = destination else {
|
||||
return Ok(());
|
||||
};
|
||||
|
||||
db.get_workspace(workspace_id)?;
|
||||
if let Some(folder_id) = folder_id {
|
||||
let folder = db.get_folder(folder_id)?;
|
||||
if folder.workspace_id != *workspace_id {
|
||||
return Err(yaak_models::error::Error::GenericError(format!(
|
||||
"Folder {folder_id} does not belong to workspace {workspace_id}"
|
||||
))
|
||||
.into());
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn validate_plan(plan: &ImportPlan) -> Result<()> {
|
||||
let invalid = |message: String| -> Result<()> {
|
||||
Err(yaak_models::error::Error::GenericError(message).into())
|
||||
};
|
||||
|
||||
match &plan.destination {
|
||||
ImportDestination::CurrentWorkspace { workspace_id, .. } => {
|
||||
if !plan.resources.workspaces.is_empty() {
|
||||
return invalid(
|
||||
"A current-workspace import plan must not contain workspace updates"
|
||||
.to_string(),
|
||||
);
|
||||
}
|
||||
|
||||
let all_workspace_ids = plan
|
||||
.resources
|
||||
.environments
|
||||
.iter()
|
||||
.map(|v| &v.resource.workspace_id)
|
||||
.chain(plan.resources.folders.iter().map(|v| &v.resource.workspace_id))
|
||||
.chain(plan.resources.http_requests.iter().map(|v| &v.resource.workspace_id))
|
||||
.chain(plan.resources.grpc_requests.iter().map(|v| &v.resource.workspace_id))
|
||||
.chain(plan.resources.websocket_requests.iter().map(|v| &v.resource.workspace_id));
|
||||
if all_workspace_ids.into_iter().any(|id| id != workspace_id) {
|
||||
return invalid(
|
||||
"A current-workspace import plan contains resources for another workspace"
|
||||
.to_string(),
|
||||
);
|
||||
}
|
||||
|
||||
if plan.resources.environments.iter().any(|v| v.resource.parent_model == "workspace") {
|
||||
return invalid(
|
||||
"A current-workspace import plan must not replace the base environment"
|
||||
.to_string(),
|
||||
);
|
||||
}
|
||||
}
|
||||
ImportDestination::NewWorkspace => {
|
||||
let workspace_ids = plan
|
||||
.resources
|
||||
.workspaces
|
||||
.iter()
|
||||
.map(|v| v.resource.id.as_str())
|
||||
.collect::<BTreeSet<_>>();
|
||||
if workspace_ids.is_empty() {
|
||||
return invalid("A new-workspace import plan has no workspace".to_string());
|
||||
}
|
||||
let all_workspace_ids = plan
|
||||
.resources
|
||||
.environments
|
||||
.iter()
|
||||
.map(|v| v.resource.workspace_id.as_str())
|
||||
.chain(plan.resources.folders.iter().map(|v| v.resource.workspace_id.as_str()))
|
||||
.chain(
|
||||
plan.resources.http_requests.iter().map(|v| v.resource.workspace_id.as_str()),
|
||||
)
|
||||
.chain(
|
||||
plan.resources.grpc_requests.iter().map(|v| v.resource.workspace_id.as_str()),
|
||||
)
|
||||
.chain(
|
||||
plan.resources
|
||||
.websocket_requests
|
||||
.iter()
|
||||
.map(|v| v.resource.workspace_id.as_str()),
|
||||
);
|
||||
if all_workspace_ids.into_iter().any(|id| !workspace_ids.contains(id)) {
|
||||
return invalid(
|
||||
"A new-workspace import plan contains resources outside its workspaces"
|
||||
.to_string(),
|
||||
);
|
||||
}
|
||||
|
||||
let mut base_environment_workspaces = BTreeSet::new();
|
||||
if plan.resources.environments.iter().any(|v| {
|
||||
v.resource.parent_model == "workspace"
|
||||
&& !base_environment_workspaces.insert(v.resource.workspace_id.as_str())
|
||||
}) {
|
||||
return invalid(
|
||||
"A new-workspace import plan contains multiple base environments for one workspace"
|
||||
.to_string(),
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
let planned_folder_ids =
|
||||
plan.resources.folders.iter().map(|v| v.resource.id.as_str()).collect::<BTreeSet<_>>();
|
||||
if plan.resources.environments.iter().any(|v| {
|
||||
v.resource.parent_model == "folder"
|
||||
&& v.resource.parent_id.as_deref().is_none_or(|id| !planned_folder_ids.contains(id))
|
||||
}) {
|
||||
return invalid(
|
||||
"An import plan must not replace an existing folder environment".to_string(),
|
||||
);
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn display_importer_name(importer: &str) -> &str {
|
||||
importer.strip_prefix("@yaak/importer-").unwrap_or(importer)
|
||||
}
|
||||
|
||||
fn workspace_fields_not_imported(source: &Workspace, destination: &Workspace) -> Vec<&'static str> {
|
||||
let mut fields = Vec::new();
|
||||
if source.name != destination.name {
|
||||
fields.push("workspace name");
|
||||
}
|
||||
if source.description != destination.description {
|
||||
fields.push("description");
|
||||
}
|
||||
if source.authentication != destination.authentication
|
||||
|| source.authentication_type != destination.authentication_type
|
||||
{
|
||||
fields.push("authentication");
|
||||
}
|
||||
if source.headers != destination.headers {
|
||||
fields.push("default headers");
|
||||
}
|
||||
if source.encryption_key_challenge != destination.encryption_key_challenge {
|
||||
fields.push("encryption configuration");
|
||||
}
|
||||
if source.setting_validate_certificates != destination.setting_validate_certificates {
|
||||
fields.push("certificate validation");
|
||||
}
|
||||
if source.setting_follow_redirects != destination.setting_follow_redirects {
|
||||
fields.push("redirect behavior");
|
||||
}
|
||||
if source.setting_request_timeout != destination.setting_request_timeout {
|
||||
fields.push("request timeout");
|
||||
}
|
||||
if source.setting_request_message_size != destination.setting_request_message_size {
|
||||
fields.push("request message size");
|
||||
}
|
||||
if source.setting_dns_overrides != destination.setting_dns_overrides {
|
||||
fields.push("DNS overrides");
|
||||
}
|
||||
if source.setting_send_cookies != destination.setting_send_cookies
|
||||
|| source.setting_store_cookies != destination.setting_store_cookies
|
||||
{
|
||||
fields.push("cookie behavior");
|
||||
}
|
||||
fields
|
||||
}
|
||||
|
||||
fn display_list(items: &BTreeSet<&str>) -> String {
|
||||
let items = items.iter().copied().collect::<Vec<_>>();
|
||||
match items.as_slice() {
|
||||
[] => String::new(),
|
||||
[item] => (*item).to_string(),
|
||||
[first, second] => format!("{first} and {second}"),
|
||||
_ => format!("{}, and {}", items[..items.len() - 1].join(", "), items[items.len() - 1]),
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use serde_json::json;
|
||||
use yaak_models::models::{EnvironmentVariable, HttpRequestHeader};
|
||||
|
||||
fn destination_workspace() -> Workspace {
|
||||
Workspace {
|
||||
id: "wk_destination".to_string(),
|
||||
model: "workspace".to_string(),
|
||||
name: "Destination".to_string(),
|
||||
authentication: BTreeMap::from([("token".to_string(), json!("keep-me"))]),
|
||||
authentication_type: Some("bearer".to_string()),
|
||||
headers: vec![HttpRequestHeader {
|
||||
enabled: true,
|
||||
name: "X-Destination".to_string(),
|
||||
value: "preserved".to_string(),
|
||||
id: None,
|
||||
}],
|
||||
setting_validate_certificates: false,
|
||||
setting_follow_redirects: false,
|
||||
setting_request_timeout: 1234,
|
||||
..Default::default()
|
||||
}
|
||||
}
|
||||
|
||||
fn imported_resources() -> ImportResources {
|
||||
ImportResources {
|
||||
workspaces: vec![Workspace {
|
||||
id: "wk_source".to_string(),
|
||||
model: "workspace".to_string(),
|
||||
name: "Imported".to_string(),
|
||||
authentication_type: Some("basic".to_string()),
|
||||
setting_validate_certificates: true,
|
||||
..Default::default()
|
||||
}],
|
||||
environments: vec![Environment {
|
||||
id: "ev_source_base".to_string(),
|
||||
model: "environment".to_string(),
|
||||
workspace_id: "wk_source".to_string(),
|
||||
name: "Global Variables".to_string(),
|
||||
parent_model: "workspace".to_string(),
|
||||
variables: vec![EnvironmentVariable {
|
||||
enabled: true,
|
||||
name: "imported".to_string(),
|
||||
value: "yes".to_string(),
|
||||
id: None,
|
||||
}],
|
||||
..Default::default()
|
||||
}],
|
||||
folders: vec![Folder {
|
||||
id: "fl_source".to_string(),
|
||||
model: "folder".to_string(),
|
||||
workspace_id: "wk_source".to_string(),
|
||||
name: "Imported Folder".to_string(),
|
||||
..Default::default()
|
||||
}],
|
||||
http_requests: vec![
|
||||
HttpRequest {
|
||||
id: "rq_root".to_string(),
|
||||
model: "http_request".to_string(),
|
||||
workspace_id: "wk_source".to_string(),
|
||||
name: "Root Request".to_string(),
|
||||
method: "GET".to_string(),
|
||||
url: "https://example.com/root".to_string(),
|
||||
..Default::default()
|
||||
},
|
||||
HttpRequest {
|
||||
id: "rq_nested".to_string(),
|
||||
model: "http_request".to_string(),
|
||||
workspace_id: "wk_source".to_string(),
|
||||
folder_id: Some("fl_source".to_string()),
|
||||
name: "Nested Request".to_string(),
|
||||
method: "GET".to_string(),
|
||||
url: "https://example.com/nested".to_string(),
|
||||
..Default::default()
|
||||
},
|
||||
],
|
||||
..Default::default()
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn current_workspace_plan_does_not_mutate_and_preserves_workspace_settings() {
|
||||
let (query_manager, _blob_manager, _rx) =
|
||||
yaak_models::init_in_memory().expect("initialize database");
|
||||
let mut destination = destination_workspace();
|
||||
let selected_folder = Folder {
|
||||
id: "fl_selected".to_string(),
|
||||
model: "folder".to_string(),
|
||||
workspace_id: destination.id.clone(),
|
||||
name: "Selected Folder".to_string(),
|
||||
..Default::default()
|
||||
};
|
||||
{
|
||||
let db = query_manager.connect();
|
||||
destination = db
|
||||
.upsert_workspace(&destination, &UpdateSource::Import)
|
||||
.expect("create destination");
|
||||
db.upsert_folder(&selected_folder, &UpdateSource::Import)
|
||||
.expect("create selected folder");
|
||||
db.upsert_environment(
|
||||
&Environment {
|
||||
id: "ev_destination_base".to_string(),
|
||||
model: "environment".to_string(),
|
||||
workspace_id: destination.id.clone(),
|
||||
name: "Destination Variables".to_string(),
|
||||
parent_model: "workspace".to_string(),
|
||||
variables: vec![EnvironmentVariable {
|
||||
enabled: true,
|
||||
name: "destination".to_string(),
|
||||
value: "keep".to_string(),
|
||||
id: None,
|
||||
}],
|
||||
..Default::default()
|
||||
},
|
||||
&UpdateSource::Import,
|
||||
)
|
||||
.expect("create base environment");
|
||||
}
|
||||
|
||||
let plan = plan_import_resources(
|
||||
&query_manager,
|
||||
"OpenAPI".to_string(),
|
||||
ImportDestination::CurrentWorkspace {
|
||||
workspace_id: destination.id.clone(),
|
||||
folder_id: Some(selected_folder.id.clone()),
|
||||
},
|
||||
imported_resources(),
|
||||
)
|
||||
.expect("plan import");
|
||||
|
||||
// Planning performed only reads.
|
||||
{
|
||||
let db = query_manager.connect();
|
||||
assert_eq!(db.list_workspaces().expect("list workspaces").len(), 1);
|
||||
assert_eq!(db.list_folders(&destination.id).expect("list folders").len(), 1);
|
||||
assert!(db.list_http_requests(&destination.id).expect("list requests").is_empty());
|
||||
assert_eq!(
|
||||
db.list_environments_ensure_base(&destination.id).expect("list environments").len(),
|
||||
1
|
||||
);
|
||||
assert_eq!(db.get_workspace(&destination.id).expect("get destination"), destination);
|
||||
}
|
||||
|
||||
assert!(plan.resources.workspaces.is_empty());
|
||||
assert_eq!(plan.resources.folders[0].resource.workspace_id, destination.id);
|
||||
assert_eq!(
|
||||
plan.resources.folders[0].resource.folder_id.as_deref(),
|
||||
Some(selected_folder.id.as_str())
|
||||
);
|
||||
let root_request = plan
|
||||
.resources
|
||||
.http_requests
|
||||
.iter()
|
||||
.find(|v| v.resource.name == "Root Request")
|
||||
.expect("root request");
|
||||
assert_eq!(root_request.resource.folder_id.as_deref(), Some(selected_folder.id.as_str()));
|
||||
let nested_request = plan
|
||||
.resources
|
||||
.http_requests
|
||||
.iter()
|
||||
.find(|v| v.resource.name == "Nested Request")
|
||||
.expect("nested request");
|
||||
assert_eq!(
|
||||
nested_request.resource.folder_id,
|
||||
Some(plan.resources.folders[0].resource.id.clone())
|
||||
);
|
||||
assert_eq!(plan.resources.environments[0].resource.parent_model, "environment");
|
||||
assert!(plan.resources.environments[0].resource.name.ends_with("(Imported)"));
|
||||
assert_eq!(plan.warnings.len(), 2);
|
||||
assert!(plan.warnings.iter().any(|warning| {
|
||||
warning.title == "Workspace settings skipped"
|
||||
&& warning.detail.starts_with("Imported ·")
|
||||
&& warning.detail.contains("authentication")
|
||||
&& warning.detail.contains("default headers")
|
||||
}));
|
||||
assert!(plan.warnings.iter().any(|warning| {
|
||||
warning.title == "Base environment kept separate"
|
||||
&& warning.detail == "Global Variables → Global Variables (Imported) · 1 variable"
|
||||
}));
|
||||
|
||||
let committed = commit_import_plan(&query_manager, plan).expect("commit import");
|
||||
assert!(committed.workspaces.is_empty());
|
||||
assert_eq!(committed.http_requests.len(), 2);
|
||||
assert_eq!(
|
||||
query_manager
|
||||
.connect()
|
||||
.get_workspace(&destination.id)
|
||||
.expect("get destination after commit"),
|
||||
destination
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn environment_collisions_are_explicit_and_do_not_overwrite() {
|
||||
let (query_manager, _blob_manager, _rx) =
|
||||
yaak_models::init_in_memory().expect("initialize database");
|
||||
let mut resources = imported_resources();
|
||||
resources.environments.extend([
|
||||
Environment {
|
||||
id: "ev_second_base".to_string(),
|
||||
model: "environment".to_string(),
|
||||
workspace_id: "wk_source".to_string(),
|
||||
name: "Second Base".to_string(),
|
||||
parent_model: "workspace".to_string(),
|
||||
..Default::default()
|
||||
},
|
||||
Environment {
|
||||
id: "ev_folder_one".to_string(),
|
||||
model: "environment".to_string(),
|
||||
workspace_id: "wk_source".to_string(),
|
||||
name: "Folder One".to_string(),
|
||||
parent_model: "folder".to_string(),
|
||||
parent_id: Some("fl_source".to_string()),
|
||||
..Default::default()
|
||||
},
|
||||
Environment {
|
||||
id: "ev_folder_two".to_string(),
|
||||
model: "environment".to_string(),
|
||||
workspace_id: "wk_source".to_string(),
|
||||
name: "Folder Two".to_string(),
|
||||
parent_model: "folder".to_string(),
|
||||
parent_id: Some("fl_source".to_string()),
|
||||
..Default::default()
|
||||
},
|
||||
]);
|
||||
|
||||
let plan = plan_import_resources(
|
||||
&query_manager,
|
||||
"Yaak".to_string(),
|
||||
ImportDestination::NewWorkspace,
|
||||
resources,
|
||||
)
|
||||
.expect("plan import");
|
||||
|
||||
assert_eq!(
|
||||
plan.resources
|
||||
.environments
|
||||
.iter()
|
||||
.filter(|v| v.resource.parent_model == "workspace")
|
||||
.count(),
|
||||
1
|
||||
);
|
||||
assert_eq!(
|
||||
plan.resources
|
||||
.environments
|
||||
.iter()
|
||||
.filter(|v| v.resource.parent_model == "folder")
|
||||
.count(),
|
||||
1
|
||||
);
|
||||
assert_eq!(plan.warnings.len(), 2);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn importer_id_conventions_all_flow_through_the_same_planner() {
|
||||
let (query_manager, _blob_manager, _rx) =
|
||||
yaak_models::init_in_memory().expect("initialize database");
|
||||
let destination = destination_workspace();
|
||||
query_manager
|
||||
.connect()
|
||||
.upsert_workspace(&destination, &UpdateSource::Import)
|
||||
.expect("create destination");
|
||||
let resources = ImportResources {
|
||||
workspaces: vec![
|
||||
Workspace {
|
||||
id: "GENERATE_ID::WORKSPACE_0".to_string(),
|
||||
model: "workspace".to_string(),
|
||||
name: "Generated ID Importer".to_string(),
|
||||
..Default::default()
|
||||
},
|
||||
Workspace {
|
||||
id: "wk_exported".to_string(),
|
||||
model: "workspace".to_string(),
|
||||
name: "Stable ID Importer".to_string(),
|
||||
..Default::default()
|
||||
},
|
||||
],
|
||||
http_requests: [
|
||||
"GENERATE_ID::WORKSPACE_0",
|
||||
"wk_exported",
|
||||
"CURRENT_WORKSPACE",
|
||||
]
|
||||
.into_iter()
|
||||
.enumerate()
|
||||
.map(|(index, workspace_id)| HttpRequest {
|
||||
id: format!("GENERATE_ID::HTTP_REQUEST_{index}"),
|
||||
model: "http_request".to_string(),
|
||||
workspace_id: workspace_id.to_string(),
|
||||
name: format!("Request {index}"),
|
||||
method: "GET".to_string(),
|
||||
..Default::default()
|
||||
})
|
||||
.collect(),
|
||||
..Default::default()
|
||||
};
|
||||
|
||||
let plan = plan_import_resources(
|
||||
&query_manager,
|
||||
"Compatibility".to_string(),
|
||||
ImportDestination::CurrentWorkspace {
|
||||
workspace_id: destination.id.clone(),
|
||||
folder_id: None,
|
||||
},
|
||||
resources,
|
||||
)
|
||||
.expect("plan import");
|
||||
|
||||
assert!(plan.resources.workspaces.is_empty());
|
||||
assert!(
|
||||
plan.resources.http_requests.iter().all(|v| v.resource.workspace_id == destination.id)
|
||||
);
|
||||
assert_eq!(
|
||||
plan.resources
|
||||
.http_requests
|
||||
.iter()
|
||||
.map(|v| v.resource.id.as_str())
|
||||
.collect::<BTreeSet<_>>()
|
||||
.len(),
|
||||
3
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn commit_rolls_back_every_resource_when_a_late_write_fails() {
|
||||
let dir = tempfile::tempdir().expect("create temp directory");
|
||||
let db_path = dir.path().join("models.sqlite");
|
||||
let blob_path = dir.path().join("blobs.sqlite");
|
||||
let (query_manager, _blob_manager, _rx) =
|
||||
yaak_models::init_standalone(&db_path, &blob_path).expect("initialize database");
|
||||
let plan = plan_import_resources(
|
||||
&query_manager,
|
||||
"OpenAPI".to_string(),
|
||||
ImportDestination::NewWorkspace,
|
||||
imported_resources(),
|
||||
)
|
||||
.expect("plan import");
|
||||
let workspace_id = plan.resources.workspaces[0].resource.id.clone();
|
||||
let environment_id = plan.resources.environments[0].resource.id.clone();
|
||||
|
||||
let connection = rusqlite::Connection::open(&db_path).expect("open test database");
|
||||
connection
|
||||
.execute_batch(&format!(
|
||||
"CREATE TRIGGER fail_import_environment BEFORE INSERT ON environments \
|
||||
WHEN NEW.id = '{environment_id}' BEGIN SELECT RAISE(FAIL, 'forced failure'); END;"
|
||||
))
|
||||
.expect("install failure trigger");
|
||||
drop(connection);
|
||||
|
||||
assert!(commit_import_plan(&query_manager, plan).is_err());
|
||||
let db = query_manager.connect();
|
||||
assert!(db.get_workspace(&workspace_id).is_err(), "workspace insert must roll back");
|
||||
assert!(db.get_environment(&environment_id).is_err(), "environment must not exist");
|
||||
}
|
||||
}
|
||||
|
||||
@@ -261,6 +261,7 @@ const DECLINED: Partial<Record<AppCmd, [reason: string, capability: CapabilityNa
|
||||
// Anything that needs files the page can't reach.
|
||||
cmd_import_data: ["Importing from a file needs a filesystem, which a browser tab has no", "localFiles"],
|
||||
cmd_import_url: ["Importing from a URL needs the send proxy, which isn't available yet", null],
|
||||
cmd_commit_import: ["Importing needs a plugin, which this host doesn't run", null],
|
||||
cmd_export_data: ["Exporting to a file isn't available in the browser yet", "localFiles"],
|
||||
cmd_save_response: ["Saving a response to disk isn't available in the browser", "localFiles"],
|
||||
cmd_save_base64_to_binary: ["Saving to disk isn't available in the browser", "localFiles"],
|
||||
|
||||
+1
-1
@@ -474,7 +474,7 @@ export type ImportRequest = { content: string, };
|
||||
|
||||
export type ImportResources = { workspaces: Array<Workspace>, environments: Array<Environment>, folders: Array<Folder>, httpRequests: Array<HttpRequest>, grpcRequests: Array<GrpcRequest>, websocketRequests: Array<WebsocketRequest>, };
|
||||
|
||||
export type ImportResponse = { resources: ImportResources, };
|
||||
export type ImportResponse = { importer: string, resources: ImportResources, };
|
||||
|
||||
export type InternalEvent = { id: string, pluginRefId: string, pluginName: string, replyId: string | null, context: PluginContext, payload: InternalEventPayload, };
|
||||
|
||||
|
||||
@@ -167,6 +167,7 @@ export class PluginInstance {
|
||||
if (reply != null) {
|
||||
const replyPayload: InternalEventPayload = {
|
||||
type: "import_response",
|
||||
importer: this.#mod.importer.name,
|
||||
resources: reply.resources as ImportResources,
|
||||
};
|
||||
this.#sendPayload(context, replyPayload, replyId);
|
||||
|
||||
Reference in New Issue
Block a user