feat: accept deploy-specific environment variable data to DeploySite, DoDeploy

Author: ndhoule

go/models/deploy_environment_variable.go

@@ -49,11 +49,13 @@ const (
 
 var installDirs = []string{"node_modules/", "bower_components/"}
 
-type uploadType int
-type pointerData struct {
-	SHA  string
-	Size int64
-}
+type (
+	uploadType  int
+	pointerData struct {
+		SHA  string
+		Size int64
+	}
+)
 
 type DeployObserver interface {
 	OnSetupWalk() error
@@ -74,6 +76,12 @@ type DeployWarner interface {
 	OnWalkWarning(path, msg string)
 }
 
+type DeployEnvironmentVariable struct {
+	Key      string
+	Value    string
+	IsSecret bool
+}
+
 // DeployOptions holds the option for creating a new deploy
 type DeployOptions struct {
 	SiteID            string
@@ -83,6 +91,7 @@ type DeployOptions struct {
 	EdgeRedirectsDir  string
 	BuildDir          string
 	LargeMediaEnabled bool
+	Environment       []*models.DeployEnvironmentVariable
 
 	IsDraft   bool
 	SkipRetry bool
@@ -270,6 +279,10 @@ func (n *Netlify) DoDeploy(ctx context.Context, options *DeployOptions, deploy *
 		deployFiles.Functions = options.functions.Sums
 	}
 
+	if len(options.Environment) > 0 {
+		deployFiles.Environment = options.Environment
+	}
+
 	if options.Observer != nil {
 		if err := options.Observer.OnSuccessfulWalk(deployFiles); err != nil {
 			return nil, err
@@ -763,7 +776,6 @@ func bundle(ctx context.Context, functionDir string, observer DeployObserver) (*
 
 func bundleFromManifest(ctx context.Context, manifestFile *os.File, observer DeployObserver) (*deployFiles, []*models.FunctionSchedule, map[string]models.FunctionConfig, error) {
 	manifestBytes, err := ioutil.ReadAll(manifestFile)
-
 	if err != nil {
 		return nil, nil, nil, err
 	}
@@ -774,7 +786,6 @@ func bundleFromManifest(ctx context.Context, manifestFile *os.File, observer Dep
 	var manifest functionsManifest
 
 	err = json.Unmarshal(manifestBytes, &manifest)
-
 	if err != nil {
 		return nil, nil, nil, fmt.Errorf("malformed functions manifest file: %w", err)
 	}
@@ -785,7 +796,6 @@ func bundleFromManifest(ctx context.Context, manifestFile *os.File, observer Dep
 
 	for _, function := range manifest.Functions {
 		fileInfo, err := os.Stat(function.Path)
-
 		if err != nil {
 			return nil, nil, nil, fmt.Errorf("manifest file specifies a function path that cannot be found: %s", function.Path)
 		}
@@ -802,7 +812,6 @@ func bundleFromManifest(ctx context.Context, manifestFile *os.File, observer Dep
 			Timeout:        function.Timeout,
 		}
 		file, err := newFunctionFile(function.Path, fileInfo, runtime, &meta, observer)
-
 		if err != nil {
 			return nil, nil, nil, err
 		}
@@ -974,7 +983,7 @@ func jsFile(i os.FileInfo) bool {
 func goFile(filePath string, i os.FileInfo, observer DeployObserver) bool {
 	warner, hasWarner := observer.(DeployWarner)
 
-	if m := i.Mode(); m&0111 == 0 && runtime.GOOS != "windows" { // check if it's an executable file. skip on windows, since it doesn't have that mode
+	if m := i.Mode(); m&0o111 == 0 && runtime.GOOS != "windows" { // check if it's an executable file. skip on windows, since it doesn't have that mode
 		if hasWarner {
 			warner.OnWalkWarning(filePath, "Go binary does not have executable permissions")
 		}
@@ -1016,8 +1025,8 @@ func ignoreFile(rel string, ignoreInstallDirs bool) bool {
 func createHeader(archive *zip.Writer, i os.FileInfo, runtime string) (io.Writer, error) {
 	if runtime == goRuntime || runtime == amazonLinux2 {
 		return archive.CreateHeader(&zip.FileHeader{
-			CreatorVersion: 3 << 8,     // indicates Unix
-			ExternalAttrs:  0777 << 16, // -rwxrwxrwx file permissions
+			CreatorVersion: 3 << 8,      // indicates Unix
+			ExternalAttrs:  0o777 << 16, // -rwxrwxrwx file permissions
 
 			// we need to make sure we don't have two ZIP files with the exact same contents - otherwise, our upload deduplication mechanism will do weird things.
 			// adding in the function name as a comment ensures that every function ZIP is unique

go/models/deploy_files.go

@@ -4146,6 +4146,28 @@ definitions:
         type: array
         items:
           $ref: '#/definitions/functionSchedule'
+  deployEnvironmentVariable:
+    type: object
+    required:
+      - key
+      - value
+      - scopes
+    properties:
+      key:
+        type: string
+      value:
+        type: string
+      is_secret:
+        type: boolean
+      scopes:
+        type: array
+        items:
+          type: string
+          enum:
+            - builds
+            - functions
+            - runtime
+            - post-processing
   deployFiles:
     type: object
     description: |
@@ -4154,6 +4176,8 @@ definitions:
       2. As a zip file using one of these methods:
          - Set Content-Type to 'application/zip' and send the zip file as the raw request body
          - Include the zip file content in the 'zip' field of this JSON object with Content-Type 'application/json'
+    required:
+      - environment
     properties:
       files:
         type: object
@@ -4186,6 +4210,27 @@ definitions:
         type: string
       framework_version:
         type: string
+      environment:
+        description: |
+          A list of deploy-specific environment variable data. Data specified this way applies only
+          to this specific deploy and is merged into any existing environment variables set on the
+          account and site.
+
+          Deploy-specific environment variable data takes precedence over account and site
+          environment variable data: For example, a deploy-specific variable with the key `NODE_ENV`
+          will take priority over any existing site- and account-level environment variable data
+          with the key `NODE_ENV`.
+
+          Environment variable data may be provided at one of two times:
+
+          - When creating a new Deploy with deploy files (most common)
+          - When finalizing an existing Deploy with deploy files
+
+          Once set, environment variables for a specific deploy cannot be modified. Subsequent
+          attempts to modify environment variable data for a deploy will be ignored.
+        type: array
+        items:
+          $ref: '#/definitions/deployEnvironmentVariable'
   pluginParams:
     type: object
     properties: