3D-printing/Cura
1
0
Fork 0
mirror of https://github.com/Ultimaker/Cura.git synced 2025-07-08 07:27:29 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

STAR-322: Fixing job uploads

Browse source
This commit is contained in:
Daniel Schiavini 2018-12-04 17:37:58 +01:00
parent 02efc9e1a9
commit 8ea4edf67e
4 changed files with 49 additions and 54 deletions
Download patch file Download diff file Expand all files Collapse all files

54
plugins/UM3NetworkPrinting/src/Cloud/CloudApiClient.py
View file

@ -11,9 +11,7 @@ from cura.API import Account
from cura.NetworkClient import NetworkClient
from plugins.UM3NetworkPrinting.src.Models import BaseModel
from plugins.UM3NetworkPrinting.src.Cloud.Models import (
CloudCluster, CloudErrorObject, CloudClusterStatus, CloudJobUploadRequest,
CloudJobResponse,
CloudPrintResponse
CloudCluster, CloudErrorObject, CloudClusterStatus, CloudJobUploadRequest, CloudPrintResponse, CloudJobResponse
)
@ -24,8 +22,8 @@ class CloudApiClient(NetworkClient):
# The cloud URL to use for this remote cluster.
# TODO: Make sure that this URL goes to the live api before release
ROOT_PATH = "https://api-staging.ultimaker.com"
CLUSTER_API_ROOT = "{}/connect/v1/".format(ROOT_PATH)
CURA_API_ROOT = "{}/cura/v1/".format(ROOT_PATH)
CLUSTER_API_ROOT = "{}/connect/v1".format(ROOT_PATH)
CURA_API_ROOT = "{}/cura/v1".format(ROOT_PATH)
## Initializes a new cloud API client.
# \param account: The user's account object
@ -38,15 +36,15 @@ class CloudApiClient(NetworkClient):
## Retrieves all the clusters for the user that is currently logged in.
# \param on_finished: The function to be called after the result is parsed.
def getClusters(self, on_finished: Callable[[List[CloudCluster]], any]) -> None:
url = "/clusters"
self.get(url, on_finished=self._createCallback(on_finished, CloudCluster))
url = "{}/clusters".format(self.CLUSTER_API_ROOT)
self.get(url, on_finished=self._wrapCallback(on_finished, CloudCluster))
## Retrieves the status of the given cluster.
# \param cluster_id: The ID of the cluster.
# \param on_finished: The function to be called after the result is parsed.
def getClusterStatus(self, cluster_id: str, on_finished: Callable[[CloudClusterStatus], any]) -> None:
url = "{}/cluster/{}/status".format(self.CLUSTER_API_ROOT, cluster_id)
self.get(url, on_finished=self._createCallback(on_finished, CloudClusterStatus))
self.get(url, on_finished=self._wrapCallback(on_finished, CloudClusterStatus))
## Requests the cloud to register the upload of a print job mesh.
# \param request: The request object.
@ -54,13 +52,16 @@ class CloudApiClient(NetworkClient):
def requestUpload(self, request: CloudJobUploadRequest, on_finished: Callable[[CloudJobResponse], any]) -> None:
url = "{}/jobs/upload".format(self.CURA_API_ROOT)
body = json.dumps({"data": request.__dict__})
self.put(url, body, on_finished=self._createCallback(on_finished, CloudJobResponse))
self.put(url, body, on_finished=self._wrapCallback(on_finished, CloudJobResponse))
## Requests the cloud to register the upload of a print job mesh.
# \param upload_response: The object received after requesting an upload with `self.requestUpload`.
# \param mesh: The mesh data to be uploaded.
# \param on_finished: The function to be called after the result is parsed. It receives the print job ID.
# \param on_progress: A function to be called during upload progress. It receives a percentage (0-100).
# \param on_error: A function to be called if the upload fails. It receives a dict with the error.
def uploadMesh(self, upload_response: CloudJobResponse, mesh: bytes, on_finished: Callable[[str], any],
on_progress: Callable[[int], any]):
on_progress: Callable[[int], any], on_error: Callable[[dict], any]):
def progressCallback(bytes_sent: int, bytes_total: int) -> None:
if bytes_total:
@ -71,7 +72,8 @@ class CloudApiClient(NetworkClient):
if status_code < 300:
on_finished(upload_response.job_id)
else:
self._uploadMeshError(status_code, response)
Logger.log("e", "Received unexpected response %s uploading mesh: %s", status_code, response)
on_error(response)
# TODO: Multipart upload
self.put(upload_response.upload_url, data = mesh, content_type = upload_response.content_type,
@ -81,9 +83,9 @@ class CloudApiClient(NetworkClient):
# \param cluster_id: The ID of the cluster.
# \param job_id: The ID of the print job.
# \param on_finished: The function to be called after the result is parsed.
def requestPrint(self, cluster_id: str, job_id: str, on_finished: Callable[[], any]) -> None:
def requestPrint(self, cluster_id: str, job_id: str, on_finished: Callable[[CloudPrintResponse], any]) -> None:
url = "{}/cluster/{}/print/{}".format(self.CLUSTER_API_ROOT, cluster_id, job_id)
self.post(url, data = "", on_finished=self._createCallback(on_finished, CloudPrintResponse))
self.post(url, data = "", on_finished=self._wrapCallback(on_finished, CloudPrintResponse))
## We override _createEmptyRequest in order to add the user credentials.
# \param url: The URL to request
@ -92,6 +94,7 @@ class CloudApiClient(NetworkClient):
request = super()._createEmptyRequest(path, content_type)
if self._account.isLoggedIn:
request.setRawHeader(b"Authorization", "Bearer {}".format(self._account.accessToken).encode())
Logger.log("i", "Created request for URL %s. Logged in = %s", path, self._account.isLoggedIn)
return request
## Parses the given JSON network reply into a status code and a dictionary, handling unexpected errors as well.
@ -102,26 +105,13 @@ class CloudApiClient(NetworkClient):
status_code = reply.attribute(QNetworkRequest.HttpStatusCodeAttribute)
try:
response = bytes(reply.readAll()).decode()
Logger.log("i", "Received an HTTP %s from %s with %s", status_code, reply.url, response)
Logger.log("i", "Received a reply %s from %s with %s", status_code, reply.url().toString(), response)
return status_code, json.loads(response)
except (UnicodeDecodeError, JSONDecodeError, ValueError) as err:
error = {"code": type(err).__name__, "title": str(err), "http_code": str(status_code)}
Logger.logException("e", "Could not parse the stardust response: %s", error)
return status_code, {"errors": [error]}
## Calls the error handler that is responsible for handling errors uploading meshes.
# \param http_status - The status of the HTTP request.
# \param response - The response received from the upload endpoint. This is not formatted according to the standard
# JSON-api response.
def _uploadMeshError(self, http_status: int, response: Dict[str, any]) -> None:
error = CloudErrorObject(
code = "uploadError",
http_status = str(http_status),
title = "Could not upload the mesh",
meta = response
)
self._on_error([error])
## The generic type variable used to document the methods below.
Model = TypeVar("Model", bound=BaseModel)
@ -141,14 +131,14 @@ class CloudApiClient(NetworkClient):
else:
Logger.log("e", "Cannot find data or errors in the cloud response: %s", response)
## Creates a callback function that includes the parsing of the response into the correct model.
## Wraps a callback function so that it includes the parsing of the response into the correct model.
# \param on_finished: The callback in case the response is successful.
# \param model: The type of the model to convert the response to. It may either be a single record or a list.
# \return: A function that can be passed to the
def _createCallback(self,
on_finished: Callable[[Union[Model, List[Model]]], any],
model: Type[Model],
) -> Callable[[QNetworkReply], None]:
def _wrapCallback(self,
on_finished: Callable[[Union[Model, List[Model]]], any],
model: Type[Model],
) -> Callable[[QNetworkReply], None]:
def parse(reply: QNetworkReply) -> None:
status_code, response = self._parseReply(reply)
return self._parseModels(response, on_finished, model)