teraslice-client-js 1.0.1 → 1.2.0

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "teraslice-client-js",
     "displayName": "Teraslice Client (JavaScript)",
-    "version": "1.0.1",
+    "version": "1.2.0",
     "description": "A Node.js client for teraslice jobs, assets, and cluster references.",
     "keywords": [
         "elasticsearch",
@@ -32,10 +32,10 @@
         "test:watch": "ts-scripts test --watch . --"
     },
     "dependencies": {
-        "@terascope/types": "^1.0.1",
-        "@terascope/utils": "^1.0.1",
-        "auto-bind": "^4.0.0",
-        "got": "^11.8.3"
+        "@terascope/types": "^1.1.0",
+        "@terascope/utils": "^1.2.0",
+        "auto-bind": "^5.0.1",
+        "got": "^13.0.0"
     },
     "devDependencies": {
         "nock": "^13.5.5"

package/src/assets.ts

@@ -3,7 +3,7 @@ import { Teraslice } from '@terascope/types';
 import path from 'node:path';
 import autoBind from 'auto-bind';
 import Client from './client.js';
-import { PostData, SearchOptions, ClientConfig } from './interfaces.js';
+import { PostData, RequestOptions, ClientConfig } from './interfaces.js';
 
 export default class Assets extends Client {
     constructor(config: ClientConfig) {
@@ -30,7 +30,7 @@ export default class Assets extends Client {
 
     async remove(
         id: string,
-        searchOptions: SearchOptions = {}
+        searchOptions: RequestOptions = {}
     ): Promise<Teraslice.AssetIDResponse> {
         if (isEmpty(id)) {
             throw new TSError('Asset delete requires a ID', {
@@ -44,7 +44,7 @@ export default class Assets extends Client {
 
     async list(
         query: Teraslice.SearchQuery = {},
-        searchOptions: SearchOptions = {}
+        searchOptions: RequestOptions = {}
     ): Promise<Teraslice.AssetRecord[]> {
         const options = { ...searchOptions, searchParams: query };
         return this.get('/assets', options);
@@ -53,7 +53,7 @@ export default class Assets extends Client {
     async getAsset(
         name: string,
         version = '',
-        searchOptions: SearchOptions = {}
+        searchOptions: RequestOptions = {}
     ): Promise<Teraslice.AssetRecord[]> {
         if (!name || !isString(name)) {
             throw new TSError('Name is required, and must be of type string', {
@@ -75,7 +75,7 @@ export default class Assets extends Client {
         name = '',
         version = '',
         query: Teraslice.TxtSearchParams = {},
-        searchOptions: SearchOptions = {}
+        searchOptions: RequestOptions = {}
     ): Promise<string> {
         if (name && !isString(name)) {
             throw new TSError('Name must be of type string', {

package/src/client.ts

@@ -5,8 +5,8 @@ import {
 } from '@terascope/utils';
 import { STATUS_CODES } from 'node:http';
 import { URL } from 'node:url';
-import got, { Got } from 'got';
-import { ClientConfig, SearchOptions, RequestOptions } from './interfaces.js';
+import got, { type Got, HTTPError } from 'got';
+import { ClientConfig, RequestOptions } from './interfaces.js';
 
 export default class Client {
     private readonly _apiVersion: string;
@@ -32,12 +32,14 @@ export default class Client {
                 limit: isTest ? 0 : 3,
                 maxRetryAfter: 15000 // 15 seconds
             },
-            timeout: config.timeout,
+            timeout: {
+                request: config.timeout
+            },
             responseType: 'json'
         });
     }
 
-    async get<T = any>(endpoint: string, options?: SearchOptions): Promise<T> {
+    async get<T = any>(endpoint: string, options?: RequestOptions): Promise<T> {
         return this._makeRequest<T>('get', endpoint, options);
     }
 
@@ -49,14 +51,14 @@ export default class Client {
         return this._makeRequest<T>('put', endpoint, options, data);
     }
 
-    async delete<T = any>(endpoint: string, options?: SearchOptions): Promise<T> {
+    async delete<T = any>(endpoint: string, options?: RequestOptions): Promise<T> {
         return this._makeRequest<T>('delete', endpoint, options);
     }
 
     private async _makeRequest<T = any>(
-        method: 'get'|'post'|'put'|'delete',
+        method: 'get' | 'post' | 'put' | 'delete',
         endpoint: string,
-        searchOptions?: RequestOptions|SearchOptions,
+        searchOptions?: RequestOptions,
         data?: any
     ): Promise<T> {
         const errorMsg = validateRequestOptions(endpoint, searchOptions);
@@ -93,7 +95,7 @@ export default class Client {
                 ...options,
             } as any) as any as T;
         } catch (err) {
-            if (err instanceof got.HTTPError) {
+            if (err instanceof HTTPError) {
                 throw makeErrorFromResponse(err.response);
             }
 
@@ -106,7 +108,7 @@ export default class Client {
     }
 
     protected makeOptions(
-        searchParams: Record<string, any>|undefined, options: RequestOptions | SearchOptions
+        searchParams: Record<string, any> | undefined, options: RequestOptions
     ): RequestOptions {
         return { ...options, searchParams };
     }
@@ -175,7 +177,7 @@ function makeErrorFromResponse(response: any): OldErrorOutput {
 }
 
 // TODO: do more validations
-function validateRequestOptions(endpoint: string, _options?: RequestOptions|SearchOptions) {
+function validateRequestOptions(endpoint: string, _options?: RequestOptions) {
     if (!endpoint) {
         return 'endpoint must not be empty';
     }
@@ -186,7 +188,7 @@ function validateRequestOptions(endpoint: string, _options?: RequestOptions|Sear
 }
 
 function getRequestOptionsWithData(
-    data: any, options: RequestOptions|SearchOptions
+    data: any, options: RequestOptions
 ): RequestOptions {
     if (isPlainObject(data) || Array.isArray(data)) {
         return { ...options, json: data };

package/src/ex.ts

@@ -5,7 +5,7 @@ import {
 import { Teraslice } from '@terascope/types';
 import autoBind from 'auto-bind';
 import Client from './client.js';
-import { ClientConfig, SearchOptions, RequestOptions } from './interfaces.js';
+import { ClientConfig, RequestOptions } from './interfaces.js';
 
 export default class Ex extends Client {
     private readonly _exId: string;
@@ -19,11 +19,13 @@ export default class Ex extends Client {
         this._exId = exId;
     }
 
-    id(): string { return this._exId; }
+    id(): string {
+        return this._exId;
+    }
 
     async stop(
         query?: Teraslice.StopQuery,
-        searchOptions: SearchOptions = {}
+        searchOptions: RequestOptions = {}
     ): Promise<Teraslice.ApiStoppedResponse> {
         const options = this.makeOptions(query, searchOptions);
         return this.post(`/ex/${this._exId}/_stop`, null, options);
@@ -31,7 +33,7 @@ export default class Ex extends Client {
 
     async pause(
         query?: Teraslice.SearchQuery,
-        searchOptions: SearchOptions = {}
+        searchOptions: RequestOptions = {}
     ): Promise<Teraslice.ApiPausedResponse> {
         const options = this.makeOptions(query, searchOptions);
         return this.post(`/ex/${this._exId}/_pause`, null, options);
@@ -39,7 +41,7 @@ export default class Ex extends Client {
 
     async resume(
         query?: Teraslice.SearchQuery,
-        searchOptions: SearchOptions = {}
+        searchOptions: RequestOptions = {}
     ): Promise<Teraslice.ApiResumeResponse> {
         const options = this.makeOptions(query, searchOptions);
         return this.post(`/ex/${this._exId}/_resume`, null, options);
@@ -47,7 +49,7 @@ export default class Ex extends Client {
 
     async recover(
         query: Teraslice.RecoverQuery = {},
-        searchOptions: SearchOptions = {}
+        searchOptions: RequestOptions = {}
     ): Promise<Ex> {
         const options = this.makeOptions(query, searchOptions);
         const result: Teraslice.ApiJobCreateResponse = await this.post(`/ex/${this._exId}/_recover`, null, options);
@@ -86,7 +88,7 @@ export default class Ex extends Client {
     async errors(options?: Teraslice.SearchQuery): Promise<Teraslice.ErrorRecord[]> {
         return this.get(`/ex/${this._exId}/errors`, {
             searchParams: options,
-        } as SearchOptions);
+        });
     }
 
     async changeWorkers(
@@ -139,7 +141,9 @@ export default class Ex extends Client {
         const startTime = Date.now();
         const options = Object.assign({}, {
             responseType: 'json',
-            timeout: intervalMs < 1000 ? 1000 : intervalMs,
+            timeout: {
+                request: intervalMs < 1000 ? 1000 : intervalMs
+            },
         }, requestOptions);
 
         const checkStatus = async (): Promise<Teraslice.ExecutionStatus> => {

package/src/executions.ts

@@ -6,7 +6,7 @@ import autoBind from 'auto-bind';
 import Client from './client.js';
 import Ex from './ex.js';
 
-import { ClientConfig, SearchOptions } from './interfaces';
+import { ClientConfig, RequestOptions } from './interfaces';
 
 type ListOptions = undefined | string | Teraslice.SearchQuery;
 
@@ -39,7 +39,7 @@ export default class Executions extends Client {
 
     async list(options?: ListOptions): Promise<Teraslice.ExecutionConfig[]> {
         const query = _parseListOptions(options);
-        return this.get('/ex', { searchParams: query } as SearchOptions);
+        return this.get('/ex', { searchParams: query } as RequestOptions);
     }
 
     async errors(
@@ -52,14 +52,14 @@ export default class Executions extends Client {
                 options.searchParams = opts;
             }
 
-            return this.get(`/ex/${exId}/errors`, options as SearchOptions);
+            return this.get(`/ex/${exId}/errors`, options as RequestOptions);
         }
 
         if (isPlainObject(exId)) {
             options.searchParams = exId;
         }
 
-        return this.get('/ex/errors', options as SearchOptions);
+        return this.get('/ex/errors', options as RequestOptions);
     }
 
     /**

package/src/interfaces.ts

@@ -1,5 +1,4 @@
-import { Omit } from '@terascope/utils';
-import * as got from 'got';
+import { Options } from 'got';
 
 export interface ClientConfig {
     host?: string;
@@ -8,8 +7,6 @@ export interface ClientConfig {
     timeout?: number;
 }
 
-export type RequestOptions = got.Options;
-
-export type SearchOptions = Omit<got.Options, 'searchParams'>;
+export type RequestOptions = Partial<Options>;
 
 export type PostData = string | NodeJS.ReadableStream | Buffer;

package/src/job.ts

@@ -5,11 +5,7 @@ import {
     TSError, toHumanTime,
 } from '@terascope/utils';
 import { Teraslice } from '@terascope/types';
-import {
-    ClientConfig,
-    SearchOptions,
-    RequestOptions
-} from './interfaces.js';
+import { ClientConfig, RequestOptions } from './interfaces.js';
 import Client from './client.js';
 
 /*
@@ -39,7 +35,9 @@ export default class Job extends Client {
         autoBind(this);
     }
 
-    id(): string { return this._jobId; }
+    id(): string {
+        return this._jobId;
+    }
 
     async slicer(requestOptions: RequestOptions = {}): Promise<Teraslice.ExecutionList> {
         return this.get(`/jobs/${this._jobId}/slicer`, requestOptions);
@@ -51,7 +49,7 @@ export default class Job extends Client {
 
     async start(
         query?: Teraslice.SearchQuery,
-        searchOptions: SearchOptions = {}
+        searchOptions: RequestOptions = {}
     ): Promise<Teraslice.ApiJobCreateResponse> {
         const options = this.makeOptions(query, searchOptions);
         return this.post(`/jobs/${this._jobId}/_start`, null, options);
@@ -59,7 +57,7 @@ export default class Job extends Client {
 
     async stop(
         query?: Teraslice.StopQuery,
-        searchOptions: SearchOptions = {}
+        searchOptions: RequestOptions = {}
     ): Promise<Teraslice.ApiStoppedResponse> {
         const options = this.makeOptions(query, searchOptions);
         return this.post(`/jobs/${this._jobId}/_stop`, null, options);
@@ -67,7 +65,7 @@ export default class Job extends Client {
 
     async pause(
         query?: Teraslice.SearchQuery,
-        searchOptions: SearchOptions = {}
+        searchOptions: RequestOptions = {}
     ): Promise<Teraslice.ApiPausedResponse> {
         const options = this.makeOptions(query, searchOptions);
         return this.post(`/jobs/${this._jobId}/_pause`, null, options);
@@ -75,7 +73,7 @@ export default class Job extends Client {
 
     async resume(
         query?: Teraslice.SearchQuery,
-        searchOptions: SearchOptions = {}
+        searchOptions: RequestOptions = {}
     ): Promise<Teraslice.ApiResumeResponse> {
         const options = this.makeOptions(query, searchOptions);
         return this.post(`/jobs/${this._jobId}/_resume`, null, options);
@@ -83,7 +81,7 @@ export default class Job extends Client {
 
     async recover(
         query: Teraslice.RecoverQuery = {},
-        searchOptions: SearchOptions = {}
+        searchOptions: RequestOptions = {}
     ): Promise<Teraslice.ApiJobCreateResponse> {
         const options = this.makeOptions(query, searchOptions);
         return this.post(`/jobs/${this._jobId}/_recover`, null, options);
@@ -101,6 +99,10 @@ export default class Job extends Client {
         return this.update(body);
     }
 
+    async deleteJob(): Promise<Teraslice.JobConfig> {
+        return this.delete(`/jobs/${this._jobId}`);
+    }
+
     async execution(requestOptions: RequestOptions = {}): Promise<Teraslice.ExecutionConfig> {
         return this.get(`/jobs/${this._jobId}/ex`, requestOptions);
     }
@@ -132,7 +134,9 @@ export default class Job extends Client {
         const startTime = Date.now();
         const options = Object.assign({}, {
             responseType: 'json',
-            timeout: intervalMs < 1000 ? 1000 : intervalMs,
+            timeout: {
+                request: intervalMs < 1000 ? 1000 : intervalMs
+            },
         }, requestOptions);
         let exId: string;
 
@@ -188,7 +192,7 @@ export default class Job extends Client {
 
     async errors(
         query: Teraslice.SearchQuery = {},
-        searchOptions: SearchOptions = {}
+        searchOptions: RequestOptions = {}
     ): Promise<Teraslice.ErrorRecord[]> {
         return this.get(`/jobs/${this._jobId}/errors`, this.makeOptions(query, searchOptions));
     }

package/src/jobs.ts

@@ -1,9 +1,9 @@
-import { isString, TSError } from '@terascope/utils';
+import { TSError } from '@terascope/utils';
 import { Teraslice } from '@terascope/types';
 import autoBind from 'auto-bind';
 import Client from './client.js';
 import Job from './job.js';
-import { SearchOptions, ClientConfig } from './interfaces.js';
+import { RequestOptions, ClientConfig } from './interfaces.js';
 
 export default class Jobs extends Client {
     constructor(config: ClientConfig) {
@@ -26,10 +26,9 @@ export default class Jobs extends Client {
     }
 
     async list(
-        status?: Teraslice.JobListStatusQuery,
-        searchOptions: SearchOptions = {}
+        query?: Teraslice.JobSearchParams,
+        searchOptions: RequestOptions = {}
     ): Promise<Teraslice.JobConfig[]> {
-        const query = _parseListOptions(status);
         return this.get('/jobs', this.makeOptions(query, searchOptions));
     }
 
@@ -41,10 +40,3 @@ export default class Jobs extends Client {
         return new Job(this._config, jobId);
     }
 }
-
-function _parseListOptions(options?: Teraslice.JobListStatusQuery): Teraslice.JobSearchParams {
-    // support legacy
-    if (!options) return { status: '*' };
-    if (isString(options)) return { status: options };
-    return options;
-}

package/test/assets-spec.ts

@@ -73,7 +73,7 @@ describe('Teraslice Assets', () => {
         // See issue: https://github.com/nock/nock/issues/2595
         // teraslice/e2e/test/cases/assets/simple-spec.ts covers this test case
         // eslint-disable-next-line jest/no-disabled-tests
-        xdescribe('when called with a stream', () => {
+        describe.skip('when called with a stream', () => {
             const testFilePath = path.join(dirname, 'fixtures', 'test.txt');
             const contents = fs.readFileSync(testFilePath, 'utf-8');
             const idResponse: AssetIDResponse = { _id: 'some-asset-id' };

package/test/client-spec.ts

@@ -84,9 +84,7 @@ describe('Teraslice Client', () => {
                 it('should resolve with the response from the server', async () => {
                     const results = await client.get('/hello', {
                         headers: { 'Some-Header': 'yes' },
-                        // @ts-expect-error
-
-                        query: { hello: true }
+                        searchParams: { hello: 'true' }
                     });
                     expect(results).toEqual({ example: 'hello' });
                 });
@@ -100,9 +98,7 @@ describe('Teraslice Client', () => {
                 });
 
                 it('should resolve with the response from the server', async () => {
-                    // @ts-expect-error
-
-                    const results = await client.get('/hello', { query: { hello: true } });
+                    const results = await client.get('/hello', { searchParams: { hello: 'true' } });
                     expect(results).toEqual({ example: 'hello' });
                 });
             });
@@ -411,9 +407,7 @@ describe('Teraslice Client', () => {
                 });
 
                 it('should resolve with the response from the server', async () => {
-                    // @ts-expect-error
-
-                    const results = await client.delete('/hello', { query: { hello: true } });
+                    const results = await client.delete('/hello', { searchParams: { hello: 'true' } });
                     expect(results).toEqual(response);
                 });
             });

package/test/executions-spec.ts

@@ -252,7 +252,7 @@ describe('Teraslice Executions', () => {
             });
 
             it('should resolve json results from Teraslice', async () => {
-                const results = await executions.errors('foo', { from: 10, });
+                const results = await executions.errors('foo', { from: 10 });
                 expect(results).toEqual(errors);
             });
         });

package/test/job-spec.ts

@@ -325,7 +325,7 @@ describe('Teraslice Job', () => {
                 _context: 'job',
                 job_id: 'some-job-id',
                 _created: 'hello',
-                _updated: 'hello',
+                _updated: 'hello'
             };
 
             beforeEach(() => {
@@ -360,7 +360,7 @@ describe('Teraslice Job', () => {
                 _context: 'job',
                 job_id: 'some-job-id',
                 _created: 'hello',
-                _updated: 'hello',
+                _updated: 'hello'
             };
 
             const expected = {
@@ -383,6 +383,21 @@ describe('Teraslice Job', () => {
         });
     });
 
+    describe('->deleteJob', () => {
+        describe('when called', () => {
+            beforeEach(() => {
+                scope.delete('/jobs/some-other-job-id')
+                    .reply(200, { job_id: 'some-other-job-id', _deleted: true });
+            });
+
+            it('should resolve json results from Teraslice', async () => {
+                const job = new Job({ baseUrl }, 'some-other-job-id');
+                const results = await job.deleteJob();
+                expect(results).toEqual({ job_id: 'some-other-job-id', _deleted: true });
+            });
+        });
+    });
+
     describe('->exId', () => {
         describe('when called with nothing', () => {
             beforeEach(() => {

package/test/jobs-spec.ts

@@ -170,7 +170,6 @@ describe('Teraslice Jobs', () => {
         describe('when called with nothing', () => {
             beforeEach(() => {
                 scope.get('/jobs')
-                    .query({ status: '*' })
                     .reply(200, list);
             });
 
@@ -180,22 +179,9 @@ describe('Teraslice Jobs', () => {
             });
         });
 
-        describe('when called with a string', () => {
-            beforeEach(() => {
-                scope.get('/jobs')
-                    .query({ status: Teraslice.ExecutionStatusEnum.running })
-                    .reply(200, list);
-            });
-
-            it('should resolve json result from Teraslice', async () => {
-                const results = await jobs.list(Teraslice.ExecutionStatusEnum.running);
-                expect(results).toEqual(list);
-            });
-        });
-
-        describe('when called with an object', () => {
+        describe('when called with a query and search objects', () => {
             const searchOptions = { headers: { 'Some-Header': 'yes' } };
-            const queryOptions = { status: Teraslice.ExecutionStatusEnum.running, size: 10 };
+            const queryOptions = { active: true, size: 10 };
 
             beforeEach(() => {
                 scope.get('/jobs')