Wait-RemoteSitecoreJob.ps1 "Fails" when Job is finished

[simoncroak]

Expected Behavior

When Wait-RemoteSitecoreJob sees that a Job is finished, the scripts should not fail, it should exit gracefully giving an update on the last status of the job

Actual Behavior

Wait-RemoteSitecoreJob fails like this when a job status has "finished":

VERBOSE: Polling job Publish to 'web'. Status : Finished and processed 12035.
VERBOSE: Finished polling job 311ef6f3-ce5c-428a-8829-92f14057ca9a;QACMSWEB1-PJ5.
VERBOSE: Preparing to invoke the script against the service at url https://xxx.xxx.com/-/script/script/?sessionId=e96d0c0d-0e27-48d1-951a-e112d2f724b2&rawOutput=False&persistentSe
ssion=False
VERBOSE: Transferring script to server
VERBOSE: Check that the service files are properly configured.
Invoke-RemoteScript : Server response: The specified script is invalid.
At C:\Program Files\WindowsPowerShell\Modules\SPE\Wait-RemoteSitecoreJob.ps1:87 char:13
+             Invoke-RemoteScript -Session $session -ScriptBlock $finis ...
+             ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : ConnectionError: (https://xxx.xxx.com/:) [Write-Error], NotFound
    + FullyQualifiedErrorId : System.Net.Http.HttpRequestException,Invoke-RemoteScript
VERBOSE: Stopping from further execution.`

Steps to Reproduce the Problem

Sitecore v10.0.1
SPE v6.3.0

• Tested issue with clean install of Sitecore and the latest available version of SPE.

• Asked questions on the Sitecore Slack Chat channel.

• Reviewed questions and answers on the Sitecore Stack Exchange.

[simoncroak]

I believe this is to do with the fact that the $finishScript here is blank/empty:

Console/Modules/SPE/Wait-RemoteSitecoreJob.ps1

Line 54 in fa730e2

$finishScript = {}

Yet here it is being passed as part of an Invoke-RemoteScript call:

Console/Modules/SPE/Wait-RemoteSitecoreJob.ps1

Line 87 in fa730e2

Invoke-RemoteScript -Session $session -ScriptBlock $finishScript

[michaellwest]

I suppose returning a 404 for this case doesn't make sense. Probably makes sense to return a 201.

Console/src/Spe/sitecore modules/PowerShell/Services/RemoteScriptCall.ashx.cs

Lines 664 to 669 in fa730e2

	if (string.IsNullOrEmpty(script))
	{
	context.Response.StatusCode = 404;
	context.Response.StatusDescription = "The specified script is invalid.";
	return;
	}

[simoncroak]

My question is more why are we doing this at all?

Console/Modules/SPE/Wait-RemoteSitecoreJob.ps1

Line 87 in fa730e2

Invoke-RemoteScript -Session $session -ScriptBlock $finishScript

[michaellwest]

Probably for consistency. Originally this was written for Wait-RemoteScriptSession. The Wait-RemoteSitecoreJob was for other jobs that run in Sitecore like publishing and indexing. Some users may only ever use Wait-RemoteScriptSession.

Console/Modules/SPE/Wait-RemoteScriptSession.ps1

Lines 71 to 74 in fa730e2

	$finishScript = {
	$backgroundScriptSession = Get-ScriptSession -Id $using:id -ErrorAction SilentlyContinue
	$backgroundScriptSession | Receive-ScriptSession
	}

[github-actions]

This issue is stale because it has been open for 365 days with no activity.

[AdamNaj]

@michaellwest Since remoting is mostly your area of expertise (I know very little about it) - I wonder if you could take a look at the pull request and accept or reject it?

[AdamNaj]

Thank you for your contribution @simoncroak