From 13a0ea006ed9f015c35505bf919921503a29791d Mon Sep 17 00:00:00 2001
From: Maxim Pertsov <maxim@viam.com>
Date: Tue, 1 Oct 2024 15:46:00 -0400
Subject: [PATCH] add first_run script path + first_run_timeout

---
 proto/viam/app/v1/app.proto   | 10 ++++++++++
 proto/viam/app/v1/robot.proto |  2 ++
 2 files changed, 12 insertions(+)

diff --git a/proto/viam/app/v1/app.proto b/proto/viam/app/v1/app.proto
index b38beced..6f100c8e 100644
--- a/proto/viam/app/v1/app.proto
+++ b/proto/viam/app/v1/app.proto
@@ -938,6 +938,8 @@ message ModuleVersion {
   repeated Model models = 3;
   // The entrypoint for this version of the module
   string entrypoint = 4;
+  // The path to a setup script that is run before a newly downloaded module starts.
+  optional string first_run = 5;
 }
 
 message ModuleMetadata {
@@ -948,6 +950,8 @@ message ModuleMetadata {
   repeated ModuleVersion versions = 2;
   // The executable to run to start the module program
   string entrypoint = 3;
+  // The path to a setup script that is run before a newly downloaded module starts.
+  optional string first_run = 4;
 }
 
 message MLModelMetadata {
@@ -1118,6 +1122,8 @@ message UpdateModuleRequest {
   repeated Model models = 5;
   // The executable to run to start the module program
   string entrypoint = 6;
+  // The path to a setup script that is run before a newly downloaded module starts.
+  optional string first_run = 7;
 }
 
 message UpdateModuleResponse {
@@ -1192,6 +1198,8 @@ message Module {
   // The public namespace of the organization that owns the module
   // This is empty if no public namespace is set
   string public_namespace = 12;
+  // The path to a setup script that is run before a newly downloaded module starts.
+  optional string first_run = 13;
 }
 
 message VersionHistory {
@@ -1203,6 +1211,8 @@ message VersionHistory {
   repeated Model models = 3;
   // The entrypoint for this version of the module
   string entrypoint = 4;
+  // The path to a setup script that is run before a newly downloaded module starts.
+  optional string first_run = 5;
 }
 
 message Uploads {
diff --git a/proto/viam/app/v1/robot.proto b/proto/viam/app/v1/robot.proto
index c3f5db0b..c307940a 100644
--- a/proto/viam/app/v1/robot.proto
+++ b/proto/viam/app/v1/robot.proto
@@ -362,6 +362,8 @@ message ModuleConfig {
   map<string, string> env = 6;
   // info about the validity of the module
   AppValidationStatus status = 7;
+  // timeout for first_run script
+  google.protobuf.Duration first_run_timeout = 8;
 }
 
 // PackageConfig is the configration for deployed Packages.