From ee538cb044075ea4dc0b4266e8f03285ee13c03b Mon Sep 17 00:00:00 2001
From: bnechyporenko <bnechyporenko@bol.com>
Date: Tue, 30 Apr 2024 21:13:35 +0200
Subject: [PATCH] Scaffolder workspace serialization

Signed-off-by: bnechyporenko <bnechyporenko@bol.com>
---
 plugins/scaffolder-backend/api-report.md | 21 +++++++++++++++------
 plugins/scaffolder-node/api-report.md    |  7 +++++--
 2 files changed, 20 insertions(+), 8 deletions(-)

diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md
index b9bf44b34f..38ee521b38 100644
--- a/plugins/scaffolder-backend/api-report.md
+++ b/plugins/scaffolder-backend/api-report.md
@@ -418,8 +418,6 @@ export class DatabaseTaskStore implements TaskStore {
     | undefined
   >;
   // (undocumented)
-  getWorkspace?(options: { taskId: string }): Promise<Buffer | undefined>;
-  // (undocumented)
   heartbeatTask(taskId: string): Promise<void>;
   // (undocumented)
   list(options: { createdBy?: string }): Promise<{
@@ -441,6 +439,11 @@ export class DatabaseTaskStore implements TaskStore {
     ids: string[];
   }>;
   // (undocumented)
+  rehydrateWorkspace?(options: {
+    taskId: string;
+    targetPath: string;
+  }): Promise<void>;
+  // (undocumented)
   saveTaskState(options: { taskId: string; state?: JsonObject }): Promise<void>;
   // (undocumented)
   serializeWorkspace(options: { path: string; taskId: string }): Promise<void>;
@@ -562,10 +565,13 @@ export class TaskManager implements TaskContext_2 {
     | undefined
   >;
   // (undocumented)
-  getWorkspace(options: { taskId: string }): Promise<Buffer | undefined>;
-  // (undocumented)
   getWorkspaceName(): Promise<string>;
   // (undocumented)
+  rehydrateWorkspace(options: {
+    taskId: string;
+    targetPath: string;
+  }): Promise<void>;
+  // (undocumented)
   get secrets(): TaskSecrets_2 | undefined;
   // (undocumented)
   serializeWorkspace?(options: { path: string }): Promise<void>;
@@ -621,8 +627,6 @@ export interface TaskStore {
     | undefined
   >;
   // (undocumented)
-  getWorkspace?(options: { taskId: string }): Promise<Buffer | undefined>;
-  // (undocumented)
   heartbeatTask(taskId: string): Promise<void>;
   // (undocumented)
   list?(options: { createdBy?: string }): Promise<{
@@ -643,6 +647,11 @@ export interface TaskStore {
     ids: string[];
   }>;
   // (undocumented)
+  rehydrateWorkspace?(options: {
+    taskId: string;
+    targetPath: string;
+  }): Promise<void>;
+  // (undocumented)
   saveTaskState?(options: {
     taskId: string;
     state?: JsonObject;
diff --git a/plugins/scaffolder-node/api-report.md b/plugins/scaffolder-node/api-report.md
index 7211dbcb28..a6b91bdccb 100644
--- a/plugins/scaffolder-node/api-report.md
+++ b/plugins/scaffolder-node/api-report.md
@@ -361,12 +361,15 @@ export interface TaskContext {
     | undefined
   >;
   // (undocumented)
-  getWorkspace?(options: { taskId: string }): Promise<Buffer | undefined>;
-  // (undocumented)
   getWorkspaceName(): Promise<string>;
   // (undocumented)
   isDryRun?: boolean;
   // (undocumented)
+  rehydrateWorkspace?(options: {
+    taskId: string;
+    targetPath: string;
+  }): Promise<void>;
+  // (undocumented)
   secrets?: TaskSecrets;
   // (undocumented)
   serializeWorkspace?(options: { path: string }): Promise<void>;