@hatchet-dev/typescript-sdk 0.0.1 → 0.0.2

package/hatchet/clients/hatchet-client/fixtures/.hatchet.yaml

@@ -1,8 +0,0 @@
-token: 'TOKEN_YAML'
-tenant_id: 'TENANT_ID_YAML'
-host_port: 'HOST_PORT_YAML'
-tls_config:
-  cert_file: 'TLS_CERT_FILE_YAML'
-  key_file: 'TLS_KEY_FILE_YAML'
-  ca_file: 'TLS_ROOT_CA_FILE_YAML'
-  server_name: 'TLS_SERVER_NAME_YAML'

package/hatchet/clients/hatchet-client/hatchet-client.test.ts

@@ -1,162 +0,0 @@
-import { ChannelCredentials, createChannel, createClientFactory } from 'nice-grpc';
-import { HatchetClient } from './hatchet-client';
-
-export const mockChannel = createChannel('localhost:50051');
-export const mockFactory = createClientFactory();
-
-describe('Client', () => {
-  beforeEach(() => {
-    process.env.HATCHET_CLIENT_TOKEN = 'TOKEN_ENV';
-  });
-
-  it('should load from environment variables', () => {
-    const hatchet = new HatchetClient(
-      {
-        token: 'TOKEN_ENV',
-        host_port: 'HOST_PORT',
-        log_level: 'OFF',
-        tls_config: {
-          cert_file: 'TLS_CERT_FILE',
-          key_file: 'TLS_KEY_FILE',
-          ca_file: 'TLS_ROOT_CA_FILE',
-          server_name: 'TLS_SERVER_NAME',
-        },
-      },
-      {
-        credentials: ChannelCredentials.createInsecure(),
-      }
-    );
-
-    expect(hatchet.config).toEqual({
-      token: 'TOKEN_ENV',
-      host_port: 'HOST_PORT',
-      log_level: 'OFF',
-      tls_config: {
-        tls_strategy: 'tls',
-        cert_file: 'TLS_CERT_FILE',
-        key_file: 'TLS_KEY_FILE',
-        ca_file: 'TLS_ROOT_CA_FILE',
-        server_name: 'TLS_SERVER_NAME',
-      },
-    });
-  });
-
-  it('should throw an error if the config param is invalid', () => {
-    expect(
-      () =>
-        new HatchetClient({
-          host_port: 'HOST_PORT',
-          tls_config: {
-            tls_strategy: 'tls',
-            cert_file: 'TLS_CERT_FILE',
-            key_file: 'TLS_KEY_FILE',
-            ca_file: 'TLS_ROOT_CA_FILE',
-            // @ts-ignore
-            server_name: undefined,
-          },
-        })
-    ).toThrow();
-  });
-
-  it('should favor config param over yaml over env vars ', () => {
-    const hatchet = new HatchetClient(
-      {
-        tls_config: {
-          cert_file: 'TLS_CERT_FILE',
-          key_file: 'TLS_KEY_FILE',
-          ca_file: 'TLS_ROOT_CA_FILE',
-          server_name: 'TLS_SERVER_NAME',
-        },
-      },
-      {
-        config_path: './fixtures/.hatchet.yaml',
-        credentials: ChannelCredentials.createInsecure(),
-      }
-    );
-
-    expect(hatchet.config).toEqual({
-      token: 'TOKEN_YAML',
-      host_port: 'HOST_PORT_YAML',
-      log_level: 'INFO',
-      tls_config: {
-        tls_strategy: 'tls',
-        cert_file: 'TLS_CERT_FILE',
-        key_file: 'TLS_KEY_FILE',
-        ca_file: 'TLS_ROOT_CA_FILE',
-        server_name: 'TLS_SERVER_NAME',
-      },
-    });
-  });
-
-  describe('with_host_port', () => {
-    it('should set the host_port', () => {
-      const hatchet = HatchetClient.with_host_port(
-        'HOST',
-        1234,
-        {
-          token: 'TOKEN',
-          tls_config: {
-            tls_strategy: 'tls',
-            cert_file: 'TLS_CERT_FILE',
-            key_file: 'TLS_KEY_FILE',
-            ca_file: 'TLS_ROOT_CA_FILE',
-            server_name: 'TLS_SERVER_NAME',
-          },
-        },
-        {
-          credentials: ChannelCredentials.createInsecure(),
-        }
-      );
-      expect(hatchet.config).toEqual({
-        token: 'TOKEN',
-        host_port: 'HOST:1234',
-        log_level: 'INFO',
-        tls_config: {
-          tls_strategy: 'tls',
-          cert_file: 'TLS_CERT_FILE',
-          key_file: 'TLS_KEY_FILE',
-          ca_file: 'TLS_ROOT_CA_FILE',
-          server_name: 'TLS_SERVER_NAME',
-        },
-      });
-    });
-  });
-
-  describe('Worker', () => {
-    let hatchet: HatchetClient;
-
-    beforeEach(() => {
-      hatchet = new HatchetClient(
-        {
-          token: 'TOKEN',
-          host_port: 'HOST_PORT',
-          log_level: 'OFF',
-          tls_config: {
-            cert_file: 'TLS_CERT_FILE',
-            key_file: 'TLS_KEY_FILE',
-            ca_file: 'TLS_ROOT_CA_FILE',
-            server_name: 'TLS_SERVER_NAME',
-          },
-        },
-        {
-          credentials: ChannelCredentials.createInsecure(),
-        }
-      );
-    });
-
-    describe('run', () => {
-      xit('should start a worker', () => {
-        const worker = hatchet.run('workflow1');
-        expect(worker).toBeDefined();
-      });
-    });
-
-    describe('worker', () => {
-      it('should start a worker', () => {
-        const worker = hatchet.worker('workflow1');
-
-        expect(worker).toBeDefined();
-      });
-    });
-  });
-});

package/hatchet/clients/hatchet-client/hatchet-client.ts

@@ -1,136 +0,0 @@
-import { z } from 'zod';
-import { ConfigLoader } from '@util/config-loader';
-import { EventClient } from '@clients/event/event-client';
-import { DispatcherClient } from '@clients/dispatcher/dispatcher-client';
-import { AdminClient } from '@clients/admin/admin-client';
-import {
-  CallOptions,
-  Channel,
-  ChannelCredentials,
-  ClientMiddlewareCall,
-  Metadata,
-  createChannel,
-  createClientFactory,
-} from 'nice-grpc';
-import { Workflow } from '@hatchet/workflow';
-import { Worker } from '@clients/worker';
-import Logger from '@hatchet/util/logger/logger';
-import { ClientConfig, ClientConfigSchema } from './client-config';
-
-export interface HatchetClientOptions {
-  config_path?: string;
-  credentials?: ChannelCredentials;
-}
-
-const addTokenMiddleware = (token: string) =>
-  async function* _<Request, Response>(
-    call: ClientMiddlewareCall<Request, Response>,
-    options: CallOptions
-  ) {
-    const optionsWithAuth: CallOptions = {
-      ...options,
-      metadata: new Metadata({ authorization: `bearer ${token}` }),
-    };
-
-    if (!call.responseStream) {
-      const response = yield* call.next(call.request, optionsWithAuth);
-
-      return response;
-    }
-
-    for await (const response of call.next(call.request, optionsWithAuth)) {
-      yield response;
-    }
-
-    return undefined;
-  };
-
-export class HatchetClient {
-  config: ClientConfig;
-  credentials: ChannelCredentials;
-  channel: Channel;
-
-  event: EventClient;
-  dispatcher: DispatcherClient;
-  admin: AdminClient;
-
-  logger: Logger;
-
-  constructor(config?: Partial<ClientConfig>, options?: HatchetClientOptions) {
-    // Initializes a new Client instance.
-    // Loads config in the following order: config param > yaml file > env vars
-
-    const loaded = ConfigLoader.load_client_config({
-      path: options?.config_path,
-    });
-
-    try {
-      const valid = ClientConfigSchema.parse({
-        ...loaded,
-        ...{ ...config, tls_config: { ...loaded.tls_config, ...config?.tls_config } },
-      });
-      this.config = valid;
-    } catch (e) {
-      if (e instanceof z.ZodError) {
-        throw new Error(`Invalid client config: ${e.message}`);
-      }
-      throw e;
-    }
-
-    this.credentials =
-      options?.credentials ?? ConfigLoader.createCredentials(this.config.tls_config);
-
-    this.channel = createChannel(this.config.host_port, this.credentials, {
-      'grpc.ssl_target_name_override': this.config.tls_config.server_name,
-    });
-
-    const clientFactory = createClientFactory().use(addTokenMiddleware(this.config.token));
-
-    this.event = new EventClient(this.config, this.channel, clientFactory);
-    this.dispatcher = new DispatcherClient(this.config, this.channel, clientFactory);
-    this.admin = new AdminClient(this.config, this.channel, clientFactory);
-
-    this.logger = new Logger('HatchetClient', this.config.log_level);
-
-    this.logger.info(`Initialized HatchetClient`);
-  }
-
-  static with_host_port(
-    host: string,
-    port: number,
-    config?: Partial<ClientConfig>,
-    options?: HatchetClientOptions
-  ): HatchetClient {
-    return new HatchetClient(
-      {
-        ...config,
-        host_port: `${host}:${port}`,
-      },
-      options
-    );
-  }
-
-  static init(config?: Partial<ClientConfig>, options?: HatchetClientOptions): HatchetClient {
-    return new HatchetClient(config, options);
-  }
-
-  async run(workflow: string | Workflow): Promise<Worker> {
-    const worker = await this.worker(workflow);
-    worker.start();
-    return worker;
-  }
-
-  async worker(workflow: string | Workflow): Promise<Worker> {
-    const name = typeof workflow === 'string' ? workflow : workflow.id;
-    const worker = new Worker(this, {
-      name,
-    });
-
-    if (typeof workflow !== 'string') {
-      await worker.register_workflow(workflow);
-      return worker;
-    }
-
-    return worker;
-  }
-}

package/hatchet/clients/hatchet-client/index.ts

@@ -1,2 +0,0 @@
-export * from './hatchet-client';
-export * from './client-config';

package/hatchet/clients/worker/index.ts

@@ -1 +0,0 @@
-export * from './worker';

package/hatchet/clients/worker/worker.test.ts

@@ -1,347 +0,0 @@
-import { HatchetClient } from '@clients/hatchet-client';
-import { ActionEventType, ActionType, AssignedAction } from '@protoc/dispatcher';
-import { ActionListener } from '@clients/dispatcher/action-listener';
-import { ServerError, Status } from 'nice-grpc-common';
-import { mockListener } from '@clients/dispatcher/action-listener.test';
-import { never } from 'zod';
-import sleep from '@util/sleep';
-import { ChannelCredentials } from 'nice-grpc';
-import { Worker } from './worker';
-import { Context } from '@hatchet/step';
-
-type AssignActionMock = AssignedAction | Error;
-
-const mockStart: AssignActionMock = {
-  tenantId: 'TENANT_ID',
-  jobId: 'job1',
-  jobName: 'Job One',
-  jobRunId: 'run1',
-  stepId: 'step1',
-  stepRunId: 'runStep1',
-  actionId: 'action1',
-  actionType: ActionType.START_STEP_RUN,
-  actionPayload: JSON.stringify('{"input": {"data": 1}}'),
-};
-
-const mockCancel: AssignActionMock = {
-  ...mockStart,
-  actionType: ActionType.CANCEL_STEP_RUN,
-};
-
-describe('Worker', () => {
-  let hatchet: HatchetClient;
-
-  beforeEach(() => {
-    hatchet = new HatchetClient(
-      {
-        token: 'TOKEN',
-        log_level: 'OFF',
-        host_port: 'HOST_PORT',
-        tls_config: {
-          cert_file: 'TLS_CERT_FILE',
-          key_file: 'TLS_KEY_FILE',
-          ca_file: 'TLS_ROOT_CA_FILE',
-          server_name: 'TLS_SERVER_NAME',
-        },
-      },
-      {
-        credentials: ChannelCredentials.createInsecure(),
-      }
-    );
-  });
-
-  describe('register_workflow', () => {
-    it('should update the registry', async () => {
-      const worker = new Worker(hatchet, { name: 'WORKER_NAME' });
-      const putWorkflowSpy = jest.spyOn(worker.client.admin, 'put_workflow').mockResolvedValue();
-
-      const workflow = {
-        id: 'workflow1',
-        description: 'test',
-        on: {
-          event: 'user:create',
-        },
-        steps: [
-          {
-            name: 'step1',
-            run: (ctx: any) => {
-              return { test: 'test' };
-            },
-          },
-        ],
-      };
-
-      await worker.register_workflow(workflow);
-
-      expect(putWorkflowSpy).toHaveBeenCalledTimes(1);
-
-      expect(worker.action_registry).toEqual({
-        [`default:step1`]: workflow.steps[0].run,
-      });
-    });
-  });
-
-  describe('handle_start_step_run', () => {
-    it('should start a step run', async () => {
-      const worker = new Worker(hatchet, { name: 'WORKER_NAME' });
-
-      const putWorkflowSpy = jest.spyOn(worker.client.admin, 'put_workflow').mockResolvedValue();
-
-      const getActionEventSpy = jest.spyOn(worker, 'get_action_event');
-
-      const sendActionEventSpy = jest
-        .spyOn(worker.client.dispatcher, 'send_action_event')
-        .mockResolvedValue({
-          tenantId: 'TENANT_ID',
-          workerId: 'WORKER_ID',
-        });
-
-      const startSpy = jest.fn().mockReturnValue({ data: 4 });
-
-      worker.action_registry = {
-        [mockStart.actionId]: startSpy,
-      };
-
-      worker.handle_start_step_run(mockStart);
-      await sleep(100);
-
-      expect(startSpy).toHaveBeenCalledTimes(1);
-
-      expect(getActionEventSpy).toHaveBeenNthCalledWith(
-        2,
-        expect.anything(),
-        ActionEventType.STEP_EVENT_TYPE_COMPLETED,
-        { data: 4 }
-      );
-      expect(worker.futures[mockStart.stepRunId]).toBeUndefined();
-      expect(sendActionEventSpy).toHaveBeenCalledTimes(2);
-    });
-
-    it('should fail gracefully', async () => {
-      const worker = new Worker(hatchet, { name: 'WORKER_NAME' });
-
-      const getActionEventSpy = jest.spyOn(worker, 'get_action_event');
-
-      const sendActionEventSpy = jest
-        .spyOn(worker.client.dispatcher, 'send_action_event')
-        .mockResolvedValue({
-          tenantId: 'TENANT_ID',
-          workerId: 'WORKER_ID',
-        });
-
-      const startSpy = jest.fn().mockRejectedValue(new Error('ERROR'));
-
-      worker.action_registry = {
-        [mockStart.actionId]: startSpy,
-      };
-
-      worker.handle_start_step_run(mockStart);
-      await sleep(100);
-
-      expect(startSpy).toHaveBeenCalledTimes(1);
-      expect(getActionEventSpy).toHaveBeenNthCalledWith(
-        2,
-        expect.anything(),
-        ActionEventType.STEP_EVENT_TYPE_FAILED,
-        expect.anything()
-      );
-      expect(worker.futures[mockStart.stepRunId]).toBeUndefined();
-      expect(sendActionEventSpy).toHaveBeenCalledTimes(2);
-    });
-  });
-
-  describe('handle_cancel_step_run', () => {
-    it('should cancel a step run', () => {
-      const worker = new Worker(hatchet, { name: 'WORKER_NAME' });
-
-      const cancelSpy = jest.fn().mockReturnValue(undefined);
-
-      worker.futures = {
-        [mockCancel.stepRunId]: {
-          cancel: cancelSpy,
-        } as any,
-      };
-
-      worker.handle_cancel_step_run(mockCancel);
-
-      expect(cancelSpy).toHaveBeenCalledTimes(1);
-      expect(worker.futures[mockCancel.stepRunId]).toBeUndefined();
-    });
-  });
-
-  describe('exit_gracefully', () => {
-    xit('should call exit_gracefully on SIGTERM', async () => {
-      const worker = new Worker(hatchet, { name: 'WORKER_NAME' });
-
-      // the spy is not working and the test is killing the test process
-      const exitSpy = jest.spyOn(worker, 'exit_gracefully').mockImplementationOnce(() => {
-        throw new Error('Simulated error');
-      });
-
-      process.emit('SIGTERM', 'SIGTERM');
-      expect(exitSpy).toHaveBeenCalledTimes(1);
-    });
-
-    xit('should call exit_gracefully on SIGINT', async () => {
-      const worker = new Worker(hatchet, { name: 'WORKER_NAME' });
-
-      // This is killing the process (as it should) fix the spy at some point
-      const exitSpy = jest.spyOn(worker, 'exit_gracefully').mockResolvedValue();
-
-      process.emit('SIGINT', 'SIGINT');
-      expect(exitSpy).toHaveBeenCalledTimes(1);
-    });
-
-    xit('should unregister the listener and exit', async () => {
-      const worker = new Worker(hatchet, { name: 'WORKER_NAME' });
-
-      jest.spyOn(process, 'exit').mockImplementation((number) => {
-        throw new Error(`EXIT ${number}`);
-      }); // This is killing the process (as it should) fix the spy at some point
-
-      const mockActionListener = new ActionListener(
-        hatchet.dispatcher,
-        mockListener([mockStart, mockStart, new ServerError(Status.CANCELLED, 'CANCELLED')]),
-        'WORKER_ID'
-      );
-
-      mockActionListener.unregister = jest.fn().mockResolvedValue(never());
-      worker.listener = mockActionListener;
-
-      expect(async () => {
-        await worker.exit_gracefully();
-      }).toThrow('EXIT 0');
-      expect(mockActionListener.unregister).toHaveBeenCalledTimes(1);
-    });
-
-    it('should exit the process if handle_kill is true', async () => {
-      const worker = new Worker(hatchet, { name: 'WORKER_NAME' });
-      const exitSpy = jest.spyOn(process, 'exit').mockReturnValue(undefined as never);
-      await worker.exit_gracefully();
-      expect(exitSpy).toHaveBeenCalledTimes(1);
-    });
-  });
-
-  describe('start', () => {
-    xit('should get actions and start runs', async () => {
-      const worker = new Worker(hatchet, { name: 'WORKER_NAME' });
-
-      const startSpy = jest.spyOn(worker, 'handle_start_step_run').mockReturnValue();
-      const cancelSpy = jest.spyOn(worker, 'handle_cancel_step_run').mockReturnValue();
-
-      const mockActionListener = new ActionListener(
-        hatchet.dispatcher,
-        mockListener([mockStart, mockStart, new ServerError(Status.CANCELLED, 'CANCELLED')]),
-        'WORKER_ID'
-      );
-
-      const getActionListenerSpy = jest
-        .spyOn(worker.client.dispatcher, 'get_action_listener')
-        .mockResolvedValue(mockActionListener);
-
-      await worker.start();
-
-      expect(getActionListenerSpy).toHaveBeenCalledTimes(1);
-      expect(startSpy).toHaveBeenCalledTimes(2);
-      expect(cancelSpy).toHaveBeenCalledTimes(0);
-    });
-
-    it('should get actions and cancel runs', async () => {
-      const worker = new Worker(hatchet, { name: 'WORKER_NAME' });
-
-      const startSpy = jest.spyOn(worker, 'handle_start_step_run').mockReturnValue();
-      const cancelSpy = jest.spyOn(worker, 'handle_cancel_step_run').mockReturnValue();
-
-      const mockActionListner = new ActionListener(
-        hatchet.dispatcher,
-        mockListener([mockStart, mockCancel, new ServerError(Status.CANCELLED, 'CANCELLED')]),
-        'WORKER_ID'
-      );
-
-      const getActionListenerSpy = jest
-        .spyOn(worker.client.dispatcher, 'get_action_listener')
-        .mockResolvedValue(mockActionListner);
-
-      await worker.start();
-
-      expect(getActionListenerSpy).toHaveBeenCalledTimes(1);
-      expect(startSpy).toHaveBeenCalledTimes(1);
-      expect(cancelSpy).toHaveBeenCalledTimes(1);
-    });
-
-    it('should retry 5 times to start a worker then throw an error', async () => {
-      const worker = new Worker(hatchet, { name: 'WORKER_NAME' });
-
-      const startSpy = jest.spyOn(worker, 'handle_start_step_run').mockReturnValue();
-      const cancelSpy = jest.spyOn(worker, 'handle_cancel_step_run').mockReturnValue();
-
-      const mockActionListner = new ActionListener(
-        hatchet.dispatcher,
-        mockListener([mockStart, mockCancel, new ServerError(Status.CANCELLED, 'CANCELLED')]),
-        'WORKER_ID'
-      );
-
-      const getActionListenerSpy = jest
-        .spyOn(worker.client.dispatcher, 'get_action_listener')
-        .mockImplementationOnce(() => {
-          throw new Error('Simulated error');
-        })
-        .mockImplementationOnce(() => {
-          throw new Error('Simulated error');
-        })
-        .mockImplementationOnce(() => {
-          throw new Error('Simulated error');
-        })
-        .mockImplementationOnce(() => {
-          throw new Error('Simulated error');
-        })
-        .mockImplementationOnce(() => {
-          throw new Error('Simulated error');
-        })
-        .mockImplementationOnce(() => {
-          throw new Error('Simulated error');
-        });
-
-      await worker.start();
-
-      expect(getActionListenerSpy).toHaveBeenCalledTimes(5);
-      expect(startSpy).toHaveBeenCalledTimes(0);
-      expect(cancelSpy).toHaveBeenCalledTimes(0);
-    });
-
-    it('should successfully run after retrying < 5 times', async () => {
-      const worker = new Worker(hatchet, { name: 'WORKER_NAME' });
-
-      const startSpy = jest.spyOn(worker, 'handle_start_step_run').mockReturnValue();
-      const cancelSpy = jest.spyOn(worker, 'handle_cancel_step_run').mockReturnValue();
-
-      const mockActionLister = new ActionListener(
-        hatchet.dispatcher,
-        mockListener([mockStart, mockCancel, new ServerError(Status.CANCELLED, 'CANCELLED')]),
-        'WORKER_ID'
-      );
-
-      const getActionListenerSpy = jest
-        .spyOn(worker.client.dispatcher, 'get_action_listener')
-        .mockImplementationOnce(() => {
-          throw new Error('Simulated error');
-        })
-        .mockImplementationOnce(() => {
-          throw new Error('Simulated error');
-        })
-        .mockImplementationOnce(() => {
-          throw new Error('Simulated error');
-        })
-        .mockImplementationOnce(() => {
-          throw new Error('Simulated error');
-        })
-        .mockImplementationOnce(async () => mockActionLister);
-
-      await worker.start();
-
-      expect(getActionListenerSpy).toHaveBeenCalledTimes(5);
-      expect(startSpy).toHaveBeenCalledTimes(1);
-      expect(cancelSpy).toHaveBeenCalledTimes(1);
-    });
-  });
-});