Skip to content

Commit

Permalink
feat(arcgis-rest-request): add a new Job class to support asynchronou…
Browse files Browse the repository at this point in the history 
…s long running tasks.

* added fetch request

* added the submit job code

* updated submit job

* trying to get viewshed to work

* added typescript to geoprocessing task

* class works with custom code

* added test for the basic submit job to results

* added on off and once method

* removed empty file

* modified function names

* fixed merge conflicts

* job is giving back results

* modified how authentication is passed down

* added more tests

* added more tests

* added more tests

* modified job.ts

* kinda added getAllResults

* removed extra code

* moved key to env file

* added more methods on job

* revised allresults and getresults method

* all tests pass expect for off method

* fixed root package.lock merge conflict

* all tests pass

* removed extra code in test

* chore: small fixes

* chore: rename file

* chore: review with Marcy

* docs: job class

* added typedoc comments to job index

* modified tests

* added a step for the local env file in readme

* Update packages/arcgis-rest-request/src/job.ts

Co-authored-by: Patrick Arlt <patrick.arlt@gmail.com>

* Update packages/arcgis-rest-request/src/job.ts

Co-authored-by: Patrick Arlt <patrick.arlt@gmail.com>

* Update packages/arcgis-rest-request/src/job.ts

Co-authored-by: Patrick Arlt <patrick.arlt@gmail.com>

* Update packages/arcgis-rest-request/src/job.ts

Co-authored-by: Patrick Arlt <patrick.arlt@gmail.com>

* Update packages/arcgis-rest-request/src/job.ts

Co-authored-by: Patrick Arlt <patrick.arlt@gmail.com>

* Update packages/arcgis-rest-request/src/job.ts

Co-authored-by: Patrick Arlt <patrick.arlt@gmail.com>

* updated doc comments

* chore: merge

* added IJobInfo interface

* Apply suggestions from code review

* chore: final clean up

* Update packages/arcgis-rest-request/src/job.ts

Co-authored-by: Gavin Rehkemper <gavinr@users.noreply.github.com>

* Update packages/arcgis-rest-request/src/job.ts

Co-authored-by: Gavin Rehkemper <gavinr@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Gavin Rehkemper <gavinr@users.noreply.github.com>

* Update demos/job/package.json

Co-authored-by: Gavin Rehkemper <gavinr@users.noreply.github.com>

* modified job.ts and demo

* fix: switch to browser demo, fix bug with default polling rate

* fix: switch to browser demo, fix bug with default polling rate

* fix: switch to browser demo, fix bug with default polling rate

* chore: switch to browser based demo, various cleanup

* chore: improve demo styles

* removed extra imports in test

* chore: merge package lock

Co-authored-by: Marcy Silverman <marcysilverman@Marcys-MBP.lan>
Co-authored-by: Marcy Silverman <marcysilverman@esri-vnimamtoh7.esri.com>
Co-authored-by: Marcy Silverman <marcysilverman@lknott1.esri.com>
Co-authored-by: Marcy Silverman <marcysilverman@dschmidt7540.esri.com>
Co-authored-by: Marcy Silverman <marcysilverman@nicklaptop.esri.com>
Co-authored-by: Marcy Silverman <marcysilverman@esri-0hqufpjaok.esri.com>
Co-authored-by: Marcy Silverman <marcysilverman@minint-mtvgqgh.esri.com>
Co-authored-by: Marcy Silverman <msilverman@esri.com>
Co-authored-by: Marcy Silverman <marcysilverman@esri-pombirbsul.esri.com>
Co-authored-by: Gavin Rehkemper <gavinr@users.noreply.github.com>
  • Loading branch information
@patrickarlt @marcysilverman @gavinr
11 people committed Sep 28, 2022
1 parent 0fabaee commit 9c222aa
Show file tree
Hide file tree
Showing 18 changed files with 1,943 additions and 23 deletions.
2 changes: 2 additions & 0 deletions demos/job/.gitignore
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules
env
54 changes: 54 additions & 0 deletions demos/job/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="utf-8">
<title>ArcGIS REST JS Browser w/ Modules</title>
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.1/dist/css/bootstrap.min.css" rel="stylesheet"
integrity="sha384-iYQeCzEYFbKjA/T2uDLTpkwGzCiq6soy8tYaI1GyVh/UjpbCx/TYkiZhlZB6+fzT" crossorigin="anonymous">
</head>

<body>
<div class="container-md mt-5">
<h1>Messages</h1>
<pre class="bg-light border p-3"><code id="messages"></code></pre>
<h1>Results</h1>
<pre class="bg-light border p-3"><code id="results"></code></pre>
</div>

<!-- Load the ES Modules Polyfill so we can use importmap in FF and Safari -->
<script async src="https://ga.jspm.io/npm:es-module-shims@1.5.18/dist/es-module-shims.js"></script>

<!-- Map package imports to URLS starting with @esri/... which will get served from the local build of the modules -->
<script type="importmap">
{
"imports": {
"@esri/arcgis-rest-request": "/@esri/arcgis-rest-request/dist/bundled/request.esm.js"
}
}
</script>

<script type="module">
import { Job, JOB_STATUSES } from "@esri/arcgis-rest-request";

Job.submitJob({
url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/911CallsHotspotPro/GPServer/911%20Calls%20Hotspot",
params: {
Query: `("DATE" > date '1998-01-01 00:00:00' AND "DATE" < date '1998-01-31 00:00:00') AND ("Day" = 'SUN' OR "Day"= 'SAT')`,
}
}).then(async (job) => {
// listen to the status event to get update every time the job status is checked.
job.on(JOB_STATUSES.Status, (jobInfo) => {
document.getElementById("messages").innerText = jobInfo.messages.map(({ description }) => description).join("\n");
});

// get all the results, this will start monitoring and trigger events
return job.getAllResults();
}).then((results) => {
console.log("RESULTS:", results);
document.getElementById("results").innerText = JSON.stringify(results, null, 2);
})
</script>
</body>

</html>
22 changes: 22 additions & 0 deletions demos/job/package.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"private": true,
"name": "job",
"version": "1.0.0",
"description": "Job Task",
"license": "Apache-2.0",
"keywords": [
"ES6",
"arcgis",
"esri",
"job"
],
"type": "module",
"main": "index.js",
"scripts": {
"start": "node ../../scripts/run-demo-server.js"
},
"dependencies": {
"@esri/arcgis-rest-request": "^4.0.3"
},
"author": "Marcy Silverman <msilverman@esri.com> (http://marcysilverman.com/)"
}
10 changes: 10 additions & 0 deletions demos/job/readme.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Job Class Demo

This demo shows how to use the `Job` class to submit a job and retrieve the results.

## Setup

1. First `npm run build` in the ArcGIS REST JS root folder to setup the dependencies.
3. Job has a `submitJob()` function that takes url, params, and authentication parameters. The response from this method returns an instance of the `Job` class.
4. To retrieve results, call `getAllResults()` in your `Job` instance which will check to see if the job is completed and returns the results if so.
5. In the terminal, run `npm start`.
104 changes: 104 additions & 0 deletions demos/job/tsconfig.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig.json to read more about this file */

/* Projects */
// "incremental": true, /* Enable incremental compilation */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */

/* Language and Environment */
"target": "es2017", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
// "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */

/* Modules */
"module": "esnext", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
"moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "resolveJsonModule": true, /* Enable importing .json files */
// "noResolve": true, /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */

/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */

/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
// "outDir": "./", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */

/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */
// "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */
// "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */

/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
},
"ts-node": {
"esm": true
}
}
Loading

0 comments on commit 9c222aa

Please sign in to comment.