Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Client and config renaming #1361

Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/cli/src/__tests__/unit/jobrunner.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ import { buildWrapper } from "@polywrap/test-env-js";
import { testCases } from "./jobrunner-test-cases";
import { JobRunner } from "../../lib";
import path from "path";
import { ClientConfigBuilder, CustomClientConfig } from "@polywrap/client-config-builder-js";
import { ClientConfigBuilder, ClientConfig } from "@polywrap/client-config-builder-js";
import { Uri } from "@polywrap/core-js";

jest.setTimeout(200000);

describe("workflow JobRunner", () => {
let defaultConfig: CustomClientConfig<Uri | string>;
let defaultConfig: ClientConfig<Uri | string>;

beforeAll(async () => {
await buildWrapper(
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/commands/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import path from "path";
import readline from "readline";
import { PolywrapClient, Uri } from "@polywrap/client-js";
import { PolywrapManifest } from "@polywrap/polywrap-manifest-types-js";
import { CustomClientConfig } from "@polywrap/client-config-builder-js";
import { ClientConfig } from "@polywrap/client-config-builder-js";

const defaultOutputDir = "./build";
const defaultStrategy = SupportedStrategies.VM;
Expand All @@ -38,7 +38,7 @@ const pathStr = intlMsg.commands_build_options_o_path();
type BuildCommandOptions = {
manifestFile: string;
outputDir: string;
clientConfig: Partial<CustomClientConfig<Uri | string>>;
clientConfig: Partial<ClientConfig<Uri | string>>;
codegen: boolean; // defaults to true
watch?: boolean;
strategy: SupportedStrategies;
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/commands/codegen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import { ScriptCodegenerator } from "../lib/codegen/ScriptCodeGenerator";
import { PolywrapClient, Uri } from "@polywrap/client-js";
import path from "path";
import fs from "fs";
import { CustomClientConfig } from "@polywrap/client-config-builder-js";
import { ClientConfig } from "@polywrap/client-config-builder-js";

const defaultCodegenDir = "./src/wrap";
const defaultPublishDir = "./build";
Expand All @@ -34,7 +34,7 @@ type CodegenCommandOptions = {
codegenDir: string;
publishDir: string;
script?: string;
clientConfig: Partial<CustomClientConfig<Uri | string>>;
clientConfig: Partial<ClientConfig<Uri | string>>;
verbose?: boolean;
quiet?: boolean;
logFile?: string;
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/commands/docgen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import { ScriptCodegenerator } from "../lib/codegen/ScriptCodeGenerator";
import { PolywrapClient, Uri } from "@polywrap/client-js";
import chalk from "chalk";
import { Argument } from "commander";
import { CustomClientConfig } from "@polywrap/client-config-builder-js";
import { ClientConfig } from "@polywrap/client-config-builder-js";

const commandToPathMap: Record<string, string> = {
schema: schemaScriptPath,
Expand All @@ -36,7 +36,7 @@ const pathStr = intlMsg.commands_codegen_options_o_path();
type DocgenCommandOptions = {
manifestFile: string;
docgenDir: string;
clientConfig: Partial<CustomClientConfig<Uri | string>>;
clientConfig: Partial<ClientConfig<Uri | string>>;
imports: boolean;
verbose?: boolean;
quiet?: boolean;
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/commands/run.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ import { Uri } from "@polywrap/client-js";
import path from "path";
import yaml from "yaml";
import fs from "fs";
import { CustomClientConfig } from "@polywrap/client-config-builder-js";
import { ClientConfig } from "@polywrap/client-config-builder-js";

type WorkflowCommandOptions = {
clientConfig: Partial<CustomClientConfig<Uri | string>>;
clientConfig: Partial<ClientConfig<Uri | string>>;
manifest: string;
jobs?: string[];
validationScript?: string;
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/lib/helpers/validate-client-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
IUriRedirect,
Uri,
} from "@polywrap/client-js";
import { CustomClientConfig } from "@polywrap/client-config-builder-js";
import { ClientConfig } from "@polywrap/client-config-builder-js";

export function validateRedirects<TUri extends Uri | string>(
redirects: readonly IUriRedirect<TUri>[]
Expand Down Expand Up @@ -122,7 +122,7 @@ export function validateEnvs<TUri extends Uri | string = string>(
}

export function validateClientConfig(
config: Partial<CustomClientConfig<Uri | string>>
config: Partial<ClientConfig<Uri | string>>
): void {
if (!config || typeof config !== "object") {
throw new Error(intlMsg.commands_run_error_clientConfigNotObject());
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/lib/option-parsers/client-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ import { getTestEnvClientConfig } from "../test-env";
import { Uri } from "@polywrap/core-js";
import {
ClientConfigBuilder,
CustomClientConfig,
ClientConfig,
} from "@polywrap/client-config-builder-js";
import path from "path";

export async function parseClientConfigOption(
clientConfig: string | undefined
): Promise<Partial<CustomClientConfig<Uri>>> {
): Promise<Partial<ClientConfig<Uri>>> {
const builder = new ClientConfigBuilder().addDefaults();

try {
Expand Down
8 changes: 4 additions & 4 deletions packages/cli/src/lib/workflow/JobRunner.ts
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
import { JobResult, Status, Step } from "./types";

import { PolywrapClient } from "@polywrap/client-js";
import { Client, MaybeAsync, Uri } from "@polywrap/core-js";
import { CoreClient, MaybeAsync, Uri } from "@polywrap/core-js";
import { WorkflowJobs } from "@polywrap/polywrap-manifest-types-js";
import {
ClientConfigBuilder,
CustomClientConfig,
ClientConfig,
} from "@polywrap/client-config-builder-js";

export class JobRunner {
private jobOutput: Map<string, JobResult>;
private client: Client;
private client: CoreClient;

constructor(
private clientConfig: Partial<CustomClientConfig<Uri | string>>,
private clientConfig: Partial<ClientConfig<Uri | string>>,
private onExecution?: (id: string, JobResult: JobResult) => MaybeAsync<void>
) {
this.jobOutput = new Map();
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/lib/workflow/types.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { CustomClientConfig } from "@polywrap/client-config-builder-js";
import { ClientConfig } from "@polywrap/client-config-builder-js";
import { Uri } from "@polywrap/core-js";

export interface Step {
Expand All @@ -7,7 +7,7 @@ export interface Step {
args?: {
[k: string]: unknown;
};
config?: CustomClientConfig<Uri | string>;
config?: ClientConfig<Uri | string>;
}

export enum Status {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
} from "@polywrap/core-js";
import { UriResolverLike } from "@polywrap/uri-resolvers-js";

export type CustomClientConfig<TUri extends Uri | string> = {
export type ClientConfig<TUri extends Uri | string> = {
readonly envs: Env<TUri>[];
readonly interfaces: InterfaceImplementations<TUri>[];
readonly redirects: IUriRedirect<TUri>[];
Expand Down
12 changes: 6 additions & 6 deletions packages/js/client-config-builder/src/ClientConfigBuilder.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { getDefaultConfig } from "./bundles";
import { CustomClientConfig } from "./CustomClientConfig";
import { ClientConfig } from "./ClientConfig";

import {
ClientConfig,
CoreClientConfig,
Uri,
IUriResolver,
IUriPackage,
Expand All @@ -22,7 +22,7 @@ import {
import { ExtendableUriResolver } from "@polywrap/uri-resolver-extensions-js";

export class ClientConfigBuilder {
private _config: CustomClientConfig<Uri> = {
private _config: ClientConfig<Uri> = {
envs: [],
interfaces: [],
redirects: [],
Expand All @@ -31,7 +31,7 @@ export class ClientConfigBuilder {
resolvers: [],
};

add(config: Partial<CustomClientConfig<Uri | string>>): ClientConfigBuilder {
add(config: Partial<ClientConfig<Uri | string>>): ClientConfigBuilder {
if (config.envs) {
this.addEnvs(config.envs);
}
Expand Down Expand Up @@ -352,14 +352,14 @@ export class ClientConfigBuilder {
return this;
}

build(): CustomClientConfig<Uri> {
build(): ClientConfig<Uri> {
return this._config;
}

buildDefault(
wrapperCache?: IWrapperCache,
resolver?: IUriResolver<unknown>
): ClientConfig<Uri> {
): CoreClientConfig<Uri> {
return {
envs: this._config.envs,
interfaces: this._config.interfaces,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { ClientConfigBuilder } from "../ClientConfigBuilder";
import {
Client,
CoreClient,
Env,
InterfaceImplementations,
Uri,
Expand All @@ -22,7 +22,7 @@ class NamedUriResolver implements IUriResolver {
}
tryResolveUri(
uri: Uri,
client: Client
client: CoreClient
): Promise<Result<UriPackageOrWrapper>> {
throw new Error("Method not implemented.");
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { CustomClientConfig } from "../CustomClientConfig";
import { ClientConfig } from "../ClientConfig";

import { IUriPackage, Uri } from "@polywrap/core-js";
import { ipfsPlugin } from "@polywrap/ipfs-plugin-js";
Expand All @@ -15,7 +15,7 @@ import { fileSystemPlugin } from "@polywrap/fs-plugin-js";
import { loggerPlugin } from "@polywrap/logger-plugin-js";
import { fileSystemResolverPlugin } from "@polywrap/fs-resolver-plugin-js";

export const getDefaultConfig = (): CustomClientConfig<Uri> => {
export const getDefaultConfig = (): ClientConfig<Uri> => {
return {
envs: [
{
Expand Down
2 changes: 1 addition & 1 deletion packages/js/client-config-builder/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
export * from "./ClientConfigBuilder";
export * from "./CustomClientConfig";
export * from "./ClientConfig";
export * from "./bundles";
4 changes: 2 additions & 2 deletions packages/js/client/src/PolywrapClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { PolywrapClientConfig } from "./PolywrapClientConfig";

import {
Wrapper,
Client,
CoreClient,
Env,
GetFileOptions,
GetImplementationsOptions,
Expand Down Expand Up @@ -38,7 +38,7 @@ import { Tracer, TracerConfig, TracingLevel } from "@polywrap/tracing-js";
import { Result, ResultErr, ResultOk } from "@polywrap/result";
import { ClientConfigBuilder } from "@polywrap/client-config-builder-js";

export class PolywrapClient implements Client {
export class PolywrapClient implements CoreClient {
private _config: PolywrapCoreClientConfig<Uri>;

/**
Expand Down
4 changes: 2 additions & 2 deletions packages/js/client/src/PolywrapClientConfig.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { Uri } from "@polywrap/core-js";
import { IWrapperCache } from "@polywrap/uri-resolvers-js";
import { TracerConfig } from "@polywrap/tracing-js";
import { CustomClientConfig } from "@polywrap/client-config-builder-js";
import { ClientConfig } from "@polywrap/client-config-builder-js";

export interface PolywrapClientConfig<TUri extends Uri | string = Uri | string>
extends CustomClientConfig<TUri> {
extends ClientConfig<TUri> {
readonly wrapperCache?: IWrapperCache;
readonly tracerConfig?: Readonly<Partial<TracerConfig>>;
}
4 changes: 2 additions & 2 deletions packages/js/client/src/PolywrapCoreClientConfig.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { ClientConfig, Uri } from "@polywrap/core-js";
import { CoreClientConfig, Uri } from "@polywrap/core-js";
import { TracerConfig } from "@polywrap/tracing-js";

export interface PolywrapCoreClientConfig<
TUri extends Uri | string = Uri | string
> extends ClientConfig<TUri> {
> extends CoreClientConfig<TUri> {
readonly tracerConfig?: Readonly<Partial<TracerConfig>>;
}
19 changes: 13 additions & 6 deletions packages/js/client/src/__tests__/e2e/memory-storage.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { Client } from "@polywrap/core-js";
import { PluginFactory, PluginModule, PluginPackage } from "@polywrap/plugin-js";
import { CoreClient } from "@polywrap/core-js";
import {
PluginFactory,
PluginModule,
PluginPackage,
} from "@polywrap/plugin-js";
import { WrapManifest } from "@polywrap/wrap-manifest-types-js";

type NoConfig = Record<string, never>;
Expand All @@ -11,13 +15,16 @@ function sleep(ms: number) {
export const makeMemoryStoragePlugin: PluginFactory<NoConfig> = () => {
class MemoryStoragePlugin extends PluginModule<NoConfig> {
private _value: number;
async getData(_: {}, _client: Client): Promise<number> {

async getData(_: {}, _client: CoreClient): Promise<number> {
await sleep(50);
return this._value;
}

async setData(args: { value: number }, _client: Client): Promise<boolean> {

async setData(
args: { value: number },
_client: CoreClient
): Promise<boolean> {
await sleep(50);
this._value = args.value;
return true;
Expand Down
Loading