Add errors array to hub api metadata and status to polling event metadata #425
Conversation
…ta. Ensure a status is added to affects: @esri/hub-downloads
| /* ready, not_ready, creating, updating, failed*/ | ||
| status: string, | ||
| /* ready, not_ready, creating, updating, failed */ | ||
| status: string; |
There was a problem hiding this comment.
why isn't this an enum?
There was a problem hiding this comment.
or a type like 'ready' | 'not_ready' | 'creating' | 'updating' | 'failed'?
That's what we use in other places for this sort of thing.
@mikeringrose I still don't have good instincts on when to use one of the many ways (type, enum, const enum, etc) TS offers for this kind of situation. Worse, I'm sort of mentally blocked on it after having been burned by making the wrong choice over in rest-js. If you have experience/insight, I think it would be great to document some guidelines here.
There was a problem hiding this comment.
@mikeringrose - I'm using a DownloadStatus type now.
| @@ -98,11 +97,11 @@ class PortalPoller implements IPoller { | |||
| .catch((error: any) => { | |||
| if (error instanceof ExportCompletionError) { | |||
| eventEmitter.emit(`${downloadId}ExportError`, { | |||
| detail: { metadata: { errors: [error] } } | |||
There was a problem hiding this comment.
this makes it look like a breaking change. in order to avoid that we should probably keep metadata.errors (in addition to detail.error) until the next major release. You can add it to this list: #305
There was a problem hiding this comment.
I've made the change to keep metadata.errors. As of this writing, the code snip above isn't updating to show it, but you can view it here.
…rs to avoid breaking change. affects: @esri/hub-downloads
|
@tomwayson - I think the linting-issues slipped in quite a while ago. I believe they occurred on a commit in which I did not use |
First off, apologies. This PR includes a lot of changes due to auto-lint fixing.
The actual purpose of the PR is to standardize the error events that get emitted if there was an error in the download export process. All error events look like:
To facilitate that, I have also changed the response of the hubDownloadMetadata method to include the
errorsarray from the Hub API.All other changes are tests and linting.