feat: Add log submission to process

Author: LuisUrr

README.md

@@ -149,6 +149,7 @@ bundle_id = "com.mitchellh.example.terraform"
 apple_id {
   username = "[email protected]"
   password = "@env:AC_PASSWORD"
+  provider = "UL304B4VGY"
 }
 
 sign {
@@ -171,7 +172,8 @@ zip {
     "bundle_id" : "com.mitchellh.example.terraform",
     "apple_id": {
         "username" : "[email protected]",
-        "password":  "@env:AC_PASSWORD"
+        "password":  "@env:AC_PASSWORD",
+        "provider":  "UL304B4VGY"
     },
     "sign" :{
         "application_identity" : "Developer ID Application: Mitchell Hashimoto"
@@ -216,7 +218,7 @@ Supported configurations:
       **NOTE**: If you have 2FA enabled, the password must be an application password, not
       your normal apple id password. See [Troubleshooting](#troubleshooting) for details.
 
-    * `provider` (`string` _optional_) - The App Store Connect provider when using
+    * `provider` (`string`) - The App Store Connect provider when using
       multiple teams within App Store Connect. If this isn't set, we'll attempt
       to read the `AC_PROVIDER` environment variable as a default.
 

cmd/gon/item.go

@@ -64,7 +64,7 @@ func (i *item) notarize(ctx context.Context, opts *processOptions) error {
 	}
 
 	// Start notarization
-	_, err := notarize.Notarize(ctx, &notarize.Options{
+	_, _, err := notarize.Notarize(ctx, &notarize.Options{
 		File:        i.Path,
 		DeveloperId: opts.Config.AppleId.Username,
 		Password:    opts.Config.AppleId.Password,
@@ -75,7 +75,7 @@ func (i *item) notarize(ctx context.Context, opts *processOptions) error {
 	})
 
 	// Save the error state. We don't save the notarization result yet
-	// because we don't know it for sure until we download the log file.
+	// because we don't know it for sure until we retrieve the log information.
 	i.State.NotarizeError = err
 
 	// If we had an error, we mention immediate we have an error.

cmd/gon/status_human.go

@@ -18,7 +18,8 @@ type statusHuman struct {
 	Prefix string
 	Lock   *sync.Mutex
 
-	lastStatus string
+	lastInfoStatus string
+	lastLogStatus  string
 }
 
 func (s *statusHuman) Submitting() {
@@ -37,13 +38,23 @@ func (s *statusHuman) Submitted(uuid string) {
 		os.Stdout, "    %sWaiting for results from Apple. This can take minutes to hours.\n", s.Prefix)
 }
 
-func (s *statusHuman) Status(info notarize.Info) {
+func (s *statusHuman) InfoStatus(info notarize.Info) {
 	s.Lock.Lock()
 	defer s.Lock.Unlock()
 
-	if info.Status != s.lastStatus {
-		s.lastStatus = info.Status
-		color.New().Fprintf(os.Stdout, "    %sStatus: %s\n", s.Prefix, info.Status)
+	if info.Status != s.lastInfoStatus {
+		s.lastInfoStatus = info.Status
+		color.New().Fprintf(os.Stdout, "    %sInfoStatus: %s\n", s.Prefix, info.Status)
+	}
+}
+
+func (s *statusHuman) LogStatus(log notarize.Log) {
+	s.Lock.Lock()
+	defer s.Lock.Unlock()
+
+	if log.Status != s.lastLogStatus {
+		s.lastLogStatus = log.Status
+		color.New().Fprintf(os.Stdout, "    %sLogStatus: %s\n", s.Prefix, log.Status)
 	}
 }
 

notarize/log.go

@@ -85,7 +85,7 @@ func log(ctx context.Context, uuid string, opts *Options) (*Log, error) {
 	cmd.Stderr = &combined
 
 	// Log what we're going to execute
-	logger.Info("requesting notarization info",
+	logger.Info("requesting notarization log",
 		"uuid", uuid,
 		"command_path", cmd.Path,
 		"command_args", cmd.Args,

notarize/notarize.go

@@ -44,7 +44,7 @@ type Options struct {
 
 	// BaseCmd is the base command for executing app submission. This is
 	// used for tests to overwrite where the codesign binary is. If this isn't
-	// specified then we use `xcrun altool` as the base.
+	// specified then we use `xcrun notarytool` as the base.
 	BaseCmd *exec.Cmd
 }
 
@@ -58,7 +58,7 @@ type Options struct {
 //
 // If error is nil, then Info is guaranteed to be non-nil.
 // If error is not nil, notarization failed and Info _may_ be non-nil.
-func Notarize(ctx context.Context, opts *Options) (*Info, error) {
+func Notarize(ctx context.Context, opts *Options) (*Info, *Log, error) {
 	logger := opts.Logger
 	if logger == nil {
 		logger = hclog.NewNullLogger()
@@ -80,18 +80,18 @@ func Notarize(ctx context.Context, opts *Options) (*Info, error) {
 	uuid, err := upload(ctx, opts)
 	lock.Unlock()
 	if err != nil {
-		return nil, err
+		return nil, nil, err
 	}
 	status.Submitted(uuid)
 
 	// Begin polling the info. The first thing we wait for is for the status
 	// _to even exist_. While we get an error requesting info with an error
 	// code of 1519 (UUID not found), then we are stuck in a queue. Sometimes
 	// this queue is hours long. We just have to wait.
-	result := &Info{RequestUUID: uuid}
+	infoResult := &Info{RequestUUID: uuid}
 	for {
 		time.Sleep(10 * time.Second)
-		_, err := info(ctx, result.RequestUUID, opts)
+		_, err := info(ctx, infoResult.RequestUUID, opts)
 		if err == nil {
 			break
 		}
@@ -103,7 +103,7 @@ func Notarize(ctx context.Context, opts *Options) (*Info, error) {
 		}
 
 		// A real error, just return that
-		return result, err
+		return infoResult, nil, err
 	}
 
 	// Now that the UUID result has been found, we poll more quickly
@@ -112,40 +112,73 @@ func Notarize(ctx context.Context, opts *Options) (*Info, error) {
 	for {
 		// Update the info. It is possible for this to return a nil info
 		// and we dont' ever want to set result to nil so we have a check.
-		newResult, err := info(ctx, result.RequestUUID, opts)
-		if newResult != nil {
-			result = newResult
+		newInfoResult, err := info(ctx, infoResult.RequestUUID, opts)
+		if newInfoResult != nil {
+			infoResult = newInfoResult
 		}
 
 		if err != nil {
 			// This code is the network became unavailable error. If this
 			// happens then we just log and retry.
 			if e, ok := err.(Errors); ok && e.ContainsCode(-19000) {
 				logger.Warn("error that network became unavailable, will retry")
-				goto RETRY
+				goto RETRYINFO
 			}
 
-			return result, err
+			return infoResult, nil, err
 		}
 
-		status.Status(*result)
+		status.InfoStatus(*infoResult)
 
 		// If we reached a terminal state then exit
-		if result.Status == "Accepted" || result.Status == "Invalid" {
+		if infoResult.Status == "Accepted" || infoResult.Status == "Invalid" {
 			break
 		}
 
-	RETRY:
+	RETRYINFO:
+		// Sleep, we just do a constant poll every 5 seconds. I haven't yet
+		// found any rate limits to the service so this seems okay.
+		time.Sleep(5 * time.Second)
+	}
+
+	logResult := &Log{JobId: uuid}
+	for {
+		// Update the log. It is possible for this to return a nil log
+		// and we dont' ever want to set result to nil so we have a check.
+		newLogResult, err := log(ctx, logResult.JobId, opts)
+		if newLogResult != nil {
+			logResult = newLogResult
+		}
+
+		if err != nil {
+			// This code is the network became unavailable error. If this
+			// happens then we just log and retry.
+			if e, ok := err.(Errors); ok && e.ContainsCode(-19000) {
+				logger.Warn("error that network became unavailable, will retry")
+				goto RETRYLOG
+			}
+
+			return infoResult, logResult, err
+		}
+
+		status.LogStatus(*logResult)
+
+		// If we reached a terminal state then exit
+		if logResult.Status == "Accepted" || logResult.Status == "Invalid" {
+			break
+		}
+
+	RETRYLOG:
 		// Sleep, we just do a constant poll every 5 seconds. I haven't yet
 		// found any rate limits to the service so this seems okay.
 		time.Sleep(5 * time.Second)
 	}
 
 	// If we're in an invalid status then return an error
 	err = nil
-	if result.Status == "Invalid" {
+	if logResult.Status == "Invalid" && infoResult.Status == "Invalid" {
 		err = fmt.Errorf("package is invalid.")
 	}
 
-	return result, err
+	return infoResult, logResult, err
 }

notarize/status.go

@@ -12,19 +12,23 @@ type Status interface {
 	// The arguments give you access to the requestUUID to query more information.
 	Submitted(requestUUID string)
 
-	// Status is called as the status of the submitted package changes.
+	// InfoStatus is called as the status of the submitted package changes.
 	// The info argument contains additional information about the status.
 	// Note that some fields in the info argument may not be populated, please
 	// refer to the docs.
-	Status(Info)
+	InfoStatus(Info)
+
+	// LogStatus is called as the status of the submitted package changes.
+	LogStatus(Log)
 }
 
 // noopStatus implements Status and does nothing.
 type noopStatus struct{}
 
 func (noopStatus) Submitting()      {}
 func (noopStatus) Submitted(string) {}
-func (noopStatus) Status(Info)      {}
+func (noopStatus) InfoStatus(Info)  {}
+func (noopStatus) LogStatus(Log)    {}
 
 // Assert that we always implement it
 var _ Status = noopStatus{}