teraslice-client-js 0.55.1 → 0.56.0

package/test/ex-spec.ts

@@ -1,11 +1,6 @@
 import nock from 'nock';
-import { RecoveryCleanupType } from '@terascope/job-components';
+import { Teraslice } from '@terascope/types';
 import Ex from '../src/ex';
-import {
-    ExecutionStatus,
-    ClusterStateNative,
-    WorkerJobProcesses
-} from '../src/interfaces';
 
 describe('Teraslice Ex', () => {
     let scope: nock.Scope;
@@ -18,7 +13,7 @@ describe('Teraslice Ex', () => {
 
     const requestOptions = { headers: { 'Random-Header': 'true' } };
 
-    const clusterState: ClusterStateNative = {
+    const clusterState: any = {
         'some-node-id': {
             hostname: 'host',
             pid: 111,
@@ -223,7 +218,7 @@ describe('Teraslice Ex', () => {
         describe('when called with a query', () => {
             beforeEach(() => {
                 scope.post('/ex/some-ex-id/_recover')
-                    .query({ cleanup: RecoveryCleanupType.errors })
+                    .query({ cleanup: Teraslice.RecoveryCleanupType.errors })
                     .reply(200, {
                         job_id: 'some-job-key',
                         ex_id: 'some-ex-key'
@@ -232,7 +227,9 @@ describe('Teraslice Ex', () => {
 
             it('should resolve json results from Teraslice', async () => {
                 const ex = new Ex({ baseUrl }, 'some-ex-id');
-                const instance = await ex.recover({ cleanup: RecoveryCleanupType.errors });
+                const instance = await ex.recover({
+                    cleanup: Teraslice.RecoveryCleanupType.errors
+                });
 
                 expect(instance).toBeInstanceOf(Ex);
                 expect(instance.id()).toEqual('some-ex-key');
@@ -253,7 +250,7 @@ describe('Teraslice Ex', () => {
             it('should resolve json results from Teraslice', async () => {
                 const ex = new Ex({ baseUrl }, 'some-ex-id');
                 const instance = await ex.recover({
-                    cleanup: RecoveryCleanupType.errors
+                    cleanup: Teraslice.RecoveryCleanupType.errors
                 }, requestOptions);
 
                 expect(instance).toBeInstanceOf(Ex);
@@ -364,15 +361,14 @@ describe('Teraslice Ex', () => {
     });
 
     describe('->workers', () => {
-        const workerData: WorkerJobProcesses[] = [];
+        const workerData: Teraslice.WorkerNode[] = [];
 
         const exId = 'some-ex-id';
         for (const [nodeName, node] of Object.entries(clusterState)) {
-            node.active.forEach((child) => {
+            // @ts-expect-error TODO: fixme
+            node.active.forEach((child: any) => {
                 if (child.assignment === 'worker' && child.ex_id === exId) {
-                    // @ts-expect-error
                     child.node_id = nodeName;
-                    // @ts-expect-error
                     workerData.push(child);
                 }
             });
@@ -502,14 +498,14 @@ describe('Teraslice Ex', () => {
                     .reply(200, {
                         ex_id: 'example-ex-id',
                         job_id: 'example-job-id',
-                        _status: ExecutionStatus.running
+                        _status: Teraslice.ExecutionStatusEnum.running
                     });
             });
 
             it('should resolve json results from Teraslice', async () => {
                 const ex = new Ex({ baseUrl }, 'example-ex-id');
-                const results = await ex.waitForStatus(ExecutionStatus.running);
-                expect(results).toEqual(ExecutionStatus.running);
+                const results = await ex.waitForStatus(Teraslice.ExecutionStatusEnum.running);
+                expect(results).toEqual(Teraslice.ExecutionStatusEnum.running);
             });
         });
 
@@ -522,19 +518,19 @@ describe('Teraslice Ex', () => {
                     .reply(200, {
                         ex_id: 'example-ex-id',
                         job_id: 'example-job-id',
-                        _status: ExecutionStatus.running
+                        _status: Teraslice.ExecutionStatusEnum.running
                     });
             });
 
             it('should resolve json results from Teraslice', async () => {
                 const ex = new Ex({ baseUrl }, 'example-ex-id');
                 const results = await ex.waitForStatus(
-                    ExecutionStatus.running,
+                    Teraslice.ExecutionStatusEnum.running,
                     1000,
                     0,
                     searchOptions
                 );
-                expect(results).toEqual(ExecutionStatus.running);
+                expect(results).toEqual(Teraslice.ExecutionStatusEnum.running);
             });
         });
 
@@ -543,20 +539,20 @@ describe('Teraslice Ex', () => {
                 scope.get('/ex/other-ex-id')
                     .reply(200, {
                         ex_id: 'other-ex-id',
-                        _status: ExecutionStatus.running
+                        _status: Teraslice.ExecutionStatusEnum.running
                     });
 
                 scope.get('/ex/other-ex-id')
                     .reply(200, {
                         ex_id: 'other-ex-id',
-                        _status: ExecutionStatus.completed
+                        _status: Teraslice.ExecutionStatusEnum.completed
                     });
             });
 
             it('should resolve json results from Teraslice', async () => {
                 const ex = new Ex({ baseUrl }, 'other-ex-id');
-                const results = await ex.waitForStatus(ExecutionStatus.completed);
-                expect(results).toEqual(ExecutionStatus.completed);
+                const results = await ex.waitForStatus(Teraslice.ExecutionStatusEnum.completed);
+                expect(results).toEqual(Teraslice.ExecutionStatusEnum.completed);
             });
         });
 
@@ -566,7 +562,7 @@ describe('Teraslice Ex', () => {
                     .times(12)
                     .reply(200, {
                         ex_id: 'foo-bar-ex-id',
-                        _status: ExecutionStatus.running
+                        _status: Teraslice.ExecutionStatusEnum.running
                     });
             });
 
@@ -574,7 +570,7 @@ describe('Teraslice Ex', () => {
                 expect.hasAssertions();
                 const ex = new Ex({ baseUrl }, 'foo-bar-ex-id');
                 try {
-                    await ex.waitForStatus(ExecutionStatus.completed, 100, 1000);
+                    await ex.waitForStatus(Teraslice.ExecutionStatusEnum.completed, 100, 1000);
                 } catch (err) {
                     expect(err.message).toEqual('Execution status failed to change from status "running" to "completed" within 1000ms');
                 }
@@ -587,20 +583,24 @@ describe('Teraslice Ex', () => {
                     .delay(1100)
                     .reply(200, {
                         ex_id: 'example-ex-id',
-                        _status: ExecutionStatus.initializing
+                        _status: Teraslice.ExecutionStatusEnum.initializing
                     });
 
                 scope.get('/ex/some-job-id')
                     .reply(200, {
                         ex_id: 'example-ex-id',
-                        _status: ExecutionStatus.running
+                        _status: Teraslice.ExecutionStatusEnum.running
                     });
             });
 
             it('should resolve with the correct status', async () => {
                 const ex = new Ex({ baseUrl }, 'some-job-id');
-                const status = await ex.waitForStatus(ExecutionStatus.running, 100, 1500);
-                expect(status).toEqual(ExecutionStatus.running);
+                const status = await ex.waitForStatus(
+                    Teraslice.ExecutionStatusEnum.running,
+                    100,
+                    1500
+                );
+                expect(status).toEqual(Teraslice.ExecutionStatusEnum.running);
             });
         });
 
@@ -609,7 +609,7 @@ describe('Teraslice Ex', () => {
                 scope.get('/ex/example-ex-id')
                     .reply(200, {
                         ex_id: 'example-ex-id',
-                        _status: ExecutionStatus.failed
+                        _status: Teraslice.ExecutionStatusEnum.failed
                     });
             });
 
@@ -617,7 +617,7 @@ describe('Teraslice Ex', () => {
                 expect.hasAssertions();
                 const ex = new Ex({ baseUrl }, 'example-ex-id');
                 try {
-                    await ex.waitForStatus(ExecutionStatus.completed, 100, 1000);
+                    await ex.waitForStatus(Teraslice.ExecutionStatusEnum.completed, 100, 1000);
                 } catch (err) {
                     const errMsg = 'Execution cannot reach the target status, "completed", because it is in the terminal state, "failed"';
                     expect(err.message).toEqual(errMsg);

package/test/job-spec.ts

@@ -1,13 +1,6 @@
 import nock from 'nock';
-import { RecoveryCleanupType, newTestJobConfig } from '@terascope/job-components';
+import { Teraslice } from '@terascope/types';
 import Job from '../src/job';
-import {
-    ExecutionStatus,
-    Execution,
-    ClusterStateNative,
-    WorkerJobProcesses,
-    JobConfiguration
-} from '../src/interfaces';
 
 describe('Teraslice Job', () => {
     let scope: nock.Scope;
@@ -20,7 +13,7 @@ describe('Teraslice Job', () => {
 
     const requestOptions = { headers: { 'Some-Header': 'yes' } };
 
-    const clusterState: ClusterStateNative = {
+    const clusterState: any = {
         'some-node-id': {
             hostname: 'host',
             pid: 111,
@@ -83,7 +76,7 @@ describe('Teraslice Job', () => {
     };
     const date = new Date().toISOString();
 
-    const executionResults: Execution[] = [
+    const executionResults: Teraslice.ExecutionRecord[] = [
         {
             active: true,
             analytics: false,
@@ -103,11 +96,14 @@ describe('Teraslice Job', () => {
             _created: date,
             _updated: date,
             _context: 'ex',
-            _status: ExecutionStatus.running,
+            _status: Teraslice.ExecutionStatusEnum.running,
             ex_id: '123456789',
             job_id: '123456789',
             slicer_hostname: 'hostname',
-            slicer_port: 5673
+            slicer_port: 5673,
+            _has_errors: false,
+            _slicer_stats: {},
+            _failureReason: ''
         },
     ];
 
@@ -252,7 +248,7 @@ describe('Teraslice Job', () => {
             it('should resolve json results from Teraslice', async () => {
                 const job = new Job({ baseUrl }, 'foo-bar');
                 const results = await job.recover({
-                    cleanup: RecoveryCleanupType.errors
+                    cleanup: Teraslice.RecoveryCleanupType.errors
                 });
                 expect(results).toEqual({ job_id: 'foo-bar' });
             });
@@ -271,7 +267,7 @@ describe('Teraslice Job', () => {
             it('should resolve json results from Teraslice', async () => {
                 const job = new Job({ baseUrl }, 'some-job-id');
                 const results = await job.recover({
-                    cleanup: RecoveryCleanupType.errors
+                    cleanup: Teraslice.RecoveryCleanupType.errors
                 }, requestOptions);
                 expect(results).toEqual({
                     key: 'some-other-key'
@@ -312,12 +308,25 @@ describe('Teraslice Job', () => {
 
     describe('->update', () => {
         describe('when updating the whole config', () => {
-            const body = newTestJobConfig({
+            const body: Teraslice.JobRecord = {
                 name: 'hello',
-            }) as JobConfiguration;
-            body.job_id = 'some-job-id';
-            body._created = 'hello';
-            body._updated = 'hello';
+                apis: [],
+                operations: [],
+                active: true,
+                analytics: false,
+                autorecover: false,
+                assets: [],
+                lifecycle: 'once',
+                max_retries: 0,
+                probation_window: 30000,
+                slicers: 1,
+                workers: 1,
+                env_vars: {},
+                _context: 'job',
+                job_id: 'some-job-id',
+                _created: 'hello',
+                _updated: 'hello',
+            };
 
             beforeEach(() => {
                 scope.put('/jobs/some-job-id', body as any)
@@ -334,12 +343,26 @@ describe('Teraslice Job', () => {
 
     describe('->updatePartial', () => {
         describe('when updating a partial config', () => {
-            const body = newTestJobConfig({
+            const body: Teraslice.JobRecord = {
                 name: 'hello',
-            }) as JobConfiguration;
-            body.job_id = 'some-job-id';
-            body._created = 'hello';
-            body._updated = 'hello';
+                apis: [],
+                operations: [],
+                active: true,
+                analytics: false,
+                autorecover: false,
+                assets: [],
+                lifecycle: 'once',
+                max_retries: 0,
+                probation_window: 30000,
+                slicers: 1,
+                workers: 1,
+                env_vars: {},
+                _context: 'job',
+                job_id: 'some-job-id',
+                _created: 'hello',
+                _updated: 'hello',
+            };
+
             const expected = {
                 ...body,
                 name: 'howdy'
@@ -489,15 +512,14 @@ describe('Teraslice Job', () => {
     });
 
     describe('->workers', () => {
-        const workerData: WorkerJobProcesses[] = [];
+        const workerData: Teraslice.WorkerNode[] = [];
 
         const jobId = 'some-job-id';
         for (const [nodeName, node] of Object.entries(clusterState)) {
+            // @ts-expect-error TODO: fixme
             node.active.forEach((child) => {
                 if (child.assignment === 'worker' && child.job_id === jobId) {
-                    // @ts-expect-error
                     child.node_id = nodeName;
-                    // @ts-expect-error
                     workerData.push(child);
                 }
             });
@@ -626,14 +648,14 @@ describe('Teraslice Job', () => {
                 scope.get('/jobs/some-job-id/ex')
                     .reply(200, {
                         ex_id: 'example-ex-id',
-                        _status: ExecutionStatus.running
+                        _status: Teraslice.ExecutionStatusEnum.running
                     });
             });
 
             it('should resolve json results from Teraslice', async () => {
                 const job = new Job({ baseUrl }, 'some-job-id');
-                const results = await job.waitForStatus(ExecutionStatus.running);
-                expect(results).toEqual(ExecutionStatus.running);
+                const results = await job.waitForStatus(Teraslice.ExecutionStatusEnum.running);
+                expect(results).toEqual(Teraslice.ExecutionStatusEnum.running);
             });
         });
 
@@ -642,18 +664,18 @@ describe('Teraslice Job', () => {
                 scope.get('/jobs/some-job-id/ex')
                     .reply(200, {
                         ex_id: 'example-ex-id',
-                        _status: ExecutionStatus.running
+                        _status: Teraslice.ExecutionStatusEnum.running
                     });
             });
 
             it('should resolve json results from Teraslice', async () => {
                 const job = new Job({ baseUrl }, 'some-job-id');
                 const results = await job.waitForStatus([
-                    ExecutionStatus.failing,
-                    ExecutionStatus.running
+                    Teraslice.ExecutionStatusEnum.failing,
+                    Teraslice.ExecutionStatusEnum.running
                 ]);
 
-                expect(results).toEqual(ExecutionStatus.running);
+                expect(results).toEqual(Teraslice.ExecutionStatusEnum.running);
             });
         });
 
@@ -665,19 +687,19 @@ describe('Teraslice Job', () => {
                     .matchHeader('Some-Header', 'yes')
                     .reply(200, {
                         ex_id: 'example-ex-id',
-                        _status: ExecutionStatus.running
+                        _status: Teraslice.ExecutionStatusEnum.running
                     });
             });
 
             it('should resolve json results from Teraslice', async () => {
                 const job = new Job({ baseUrl }, 'some-job-id');
                 const results = await job.waitForStatus(
-                    ExecutionStatus.running,
+                    Teraslice.ExecutionStatusEnum.running,
                     1000,
                     0,
                     searchOptions
                 );
-                expect(results).toEqual(ExecutionStatus.running);
+                expect(results).toEqual(Teraslice.ExecutionStatusEnum.running);
             });
         });
 
@@ -686,20 +708,20 @@ describe('Teraslice Job', () => {
                 scope.get('/jobs/some-job-id/ex')
                     .reply(200, {
                         ex_id: 'example-ex-id',
-                        _status: ExecutionStatus.running
+                        _status: Teraslice.ExecutionStatusEnum.running
                     });
 
                 scope.get('/jobs/some-job-id/ex')
                     .reply(200, {
                         ex_id: 'example-ex-id',
-                        _status: ExecutionStatus.completed
+                        _status: Teraslice.ExecutionStatusEnum.completed
                     });
             });
 
             it('should resolve json results from Teraslice', async () => {
                 const job = new Job({ baseUrl }, 'some-job-id');
-                const results = await job.waitForStatus(ExecutionStatus.completed);
-                expect(results).toEqual(ExecutionStatus.completed);
+                const results = await job.waitForStatus(Teraslice.ExecutionStatusEnum.completed);
+                expect(results).toEqual(Teraslice.ExecutionStatusEnum.completed);
             });
         });
 
@@ -708,25 +730,25 @@ describe('Teraslice Job', () => {
                 scope.get('/jobs/some-job-id/ex')
                     .reply(200, {
                         ex_id: 'example-ex-id',
-                        _status: ExecutionStatus.running
+                        _status: Teraslice.ExecutionStatusEnum.running
                     });
 
                 scope.get('/jobs/some-job-id/ex')
                     .reply(200, {
                         ex_id: 'example-ex-id',
-                        _status: ExecutionStatus.terminated
+                        _status: Teraslice.ExecutionStatusEnum.terminated
                     });
             });
 
             it('should resolve json results from Teraslice', async () => {
                 const job = new Job({ baseUrl }, 'some-job-id');
                 const results = await job.waitForStatus([
-                    ExecutionStatus.completed,
-                    ExecutionStatus.failed,
-                    ExecutionStatus.terminated
+                    Teraslice.ExecutionStatusEnum.completed,
+                    Teraslice.ExecutionStatusEnum.failed,
+                    Teraslice.ExecutionStatusEnum.terminated
                 ]);
 
-                expect(results).toEqual(ExecutionStatus.terminated);
+                expect(results).toEqual(Teraslice.ExecutionStatusEnum.terminated);
             });
         });
 
@@ -736,14 +758,14 @@ describe('Teraslice Job', () => {
                     .times(1)
                     .reply(200, {
                         ex_id: 'example-ex-id',
-                        _status: ExecutionStatus.initializing
+                        _status: Teraslice.ExecutionStatusEnum.initializing
                     });
 
                 scope.get('/jobs/some-job-id/ex')
                     .times(11)
                     .reply(200, {
                         ex_id: 'example-ex-id',
-                        _status: ExecutionStatus.running
+                        _status: Teraslice.ExecutionStatusEnum.running
                     });
             });
 
@@ -751,7 +773,7 @@ describe('Teraslice Job', () => {
                 expect.hasAssertions();
                 const job = new Job({ baseUrl }, 'some-job-id');
                 try {
-                    await job.waitForStatus(ExecutionStatus.completed, 100, 1000);
+                    await job.waitForStatus(Teraslice.ExecutionStatusEnum.completed, 100, 1000);
                 } catch (err) {
                     expect(err.message).toEqual('Job status failed to change from status "running" to "completed" within 1000ms');
                 }
@@ -764,14 +786,14 @@ describe('Teraslice Job', () => {
                     .times(1)
                     .reply(200, {
                         ex_id: 'example-ex-id',
-                        _status: ExecutionStatus.initializing
+                        _status: Teraslice.ExecutionStatusEnum.initializing
                     });
 
                 scope.get('/jobs/some-job-id/ex')
                     .times(11)
                     .reply(200, {
                         ex_id: 'example-ex-id',
-                        _status: ExecutionStatus.running
+                        _status: Teraslice.ExecutionStatusEnum.running
                     });
             });
 
@@ -780,9 +802,9 @@ describe('Teraslice Job', () => {
                 const job = new Job({ baseUrl }, 'some-job-id');
                 try {
                     await job.waitForStatus([
-                        ExecutionStatus.completed,
-                        ExecutionStatus.failed,
-                        ExecutionStatus.stopped
+                        Teraslice.ExecutionStatusEnum.completed,
+                        Teraslice.ExecutionStatusEnum.failed,
+                        Teraslice.ExecutionStatusEnum.stopped
                     ], 100, 1000);
                 } catch (err) {
                     expect(err.message).toEqual('Job status failed to change from status "running" to "completed,failed,stopped" within 1000ms');
@@ -796,20 +818,24 @@ describe('Teraslice Job', () => {
                     .delay(1100)
                     .reply(200, {
                         ex_id: 'example-ex-id',
-                        _status: ExecutionStatus.initializing
+                        _status: Teraslice.ExecutionStatusEnum.initializing
                     });
 
                 scope.get('/jobs/some-job-id/ex')
                     .reply(200, {
                         ex_id: 'example-ex-id',
-                        _status: ExecutionStatus.running
+                        _status: Teraslice.ExecutionStatusEnum.running
                     });
             });
 
             it('should resolve with the correct status', async () => {
                 const job = new Job({ baseUrl }, 'some-job-id');
-                const status = await job.waitForStatus(ExecutionStatus.running, 100, 1500);
-                expect(status).toEqual(ExecutionStatus.running);
+                const status = await job.waitForStatus(
+                    Teraslice.ExecutionStatusEnum.running,
+                    100,
+                    1500
+                );
+                expect(status).toEqual(Teraslice.ExecutionStatusEnum.running);
             });
         });
 
@@ -818,7 +844,7 @@ describe('Teraslice Job', () => {
                 scope.get('/jobs/other-job-id/ex')
                     .reply(200, {
                         ex_id: 'example-ex-id',
-                        _status: ExecutionStatus.failed
+                        _status: Teraslice.ExecutionStatusEnum.failed
                     });
             });
 
@@ -826,7 +852,7 @@ describe('Teraslice Job', () => {
                 expect.hasAssertions();
                 const job = new Job({ baseUrl }, 'other-job-id');
                 try {
-                    await job.waitForStatus(ExecutionStatus.completed, 100, 1000);
+                    await job.waitForStatus(Teraslice.ExecutionStatusEnum.completed, 100, 1000);
                 } catch (err) {
                     const errMsg = 'Job cannot reach the target status, "completed", because it is in the terminal state, "failed"';
                     expect(err.message).toEqual(errMsg);

package/test/jobs-spec.ts

@@ -1,8 +1,8 @@
 import 'jest-extended';
 import nock from 'nock';
+import { Teraslice } from '@terascope/types';
 import Job from '../src/job';
 import Jobs from '../src/jobs';
-import { ExecutionStatus, JobConfiguration } from '../src/interfaces';
 
 describe('Teraslice Jobs', () => {
     let jobs: Jobs;
@@ -22,7 +22,7 @@ describe('Teraslice Jobs', () => {
 
     const date = new Date().toISOString();
 
-    const list: JobConfiguration[] = [
+    const list: Teraslice.JobRecord[] = [
         {
             job_id: 'some-random-job-id',
             active: true,
@@ -183,19 +183,19 @@ describe('Teraslice Jobs', () => {
         describe('when called with a string', () => {
             beforeEach(() => {
                 scope.get('/jobs')
-                    .query({ status: ExecutionStatus.running })
+                    .query({ status: Teraslice.ExecutionStatusEnum.running })
                     .reply(200, list);
             });
 
             it('should resolve json result from Teraslice', async () => {
-                const results = await jobs.list(ExecutionStatus.running);
+                const results = await jobs.list(Teraslice.ExecutionStatusEnum.running);
                 expect(results).toEqual(list);
             });
         });
 
         describe('when called with an object', () => {
             const searchOptions = { headers: { 'Some-Header': 'yes' } };
-            const queryOptions = { status: ExecutionStatus.running, size: 10 };
+            const queryOptions = { status: Teraslice.ExecutionStatusEnum.running, size: 10 };
 
             beforeEach(() => {
                 scope.get('/jobs')