Skip to content

Commit

Permalink
chore: fix file formats
Browse files Browse the repository at this point in the history
  • Loading branch information
@bombillazo
bombillazo committed Feb 12, 2024
1 parent 4f5e2cb commit 5f2dcf9
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 59 deletions.
114 changes: 57 additions & 57 deletions connection/connection_params.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -176,19 +176,21 @@ export type ClientOptions = {
};

/** The configuration options required to set up a Client instance */
export type ClientConfiguration = Required<
Omit<
ClientOptions,
"password" | "port" | "tls" | "connection" | "options" | "controls"
export type ClientConfiguration =
& Required<
Omit<
ClientOptions,
"password" | "port" | "tls" | "connection" | "options" | "controls"
>
>
> & {
connection: ConnectionOptions;
controls?: ClientControls;
options: Record<string, string>;
password?: string;
port: number;
tls: TLSOptions;
};
& {
connection: ConnectionOptions;
controls?: ClientControls;
options: Record<string, string>;
password?: string;
port: number;
tls: TLSOptions;
};

function formatMissingParams(missingParams: string[]) {
return `Missing connection parameters: ${missingParams.join(", ")}`;
Expand All @@ -204,7 +206,7 @@ function formatMissingParams(missingParams: string[]) {
function assertRequiredOptions(
options: Partial<ClientConfiguration>,
requiredKeys: (keyof ClientOptions)[],
has_env_access: boolean
has_env_access: boolean,
): asserts options is ClientConfiguration {
const missingParams: (keyof ClientOptions)[] = [];
for (const key of requiredKeys) {
Expand Down Expand Up @@ -252,7 +254,7 @@ function parseOptionsArgument(options: string): Record<string, string> {
if (args[x] === "-c") {
if (args[x + 1] === undefined) {
throw new Error(
`No provided value for "${args[x]}" in options parameter`
`No provided value for "${args[x]}" in options parameter`,
);
}

Expand All @@ -261,7 +263,7 @@ function parseOptionsArgument(options: string): Record<string, string> {
x++;
} else {
throw new Error(
`Argument "${args[x]}" is not supported in options parameter`
`Argument "${args[x]}" is not supported in options parameter`,
);
}
} else if (/^--\w/.test(args[x])) {
Expand Down Expand Up @@ -299,10 +301,9 @@ function parseOptionsFromUri(connection_string: string): ClientOptions {
port: uri.port || uri.params.port,
// Compatibility with JDBC, not standard
// Treat as sslmode=require
sslmode:
uri.params.ssl === "true"
? "require"
: (uri.params.sslmode as TLSModes),
sslmode: uri.params.ssl === "true"
? "require"
: (uri.params.sslmode as TLSModes),
user: uri.user || uri.params.user,
};
} catch (e) {
Expand All @@ -311,15 +312,13 @@ function parseOptionsFromUri(connection_string: string): ClientOptions {

if (!["postgres", "postgresql"].includes(postgres_uri.driver)) {
throw new ConnectionParamsError(
`Supplied DSN has invalid driver: ${postgres_uri.driver}.`
`Supplied DSN has invalid driver: ${postgres_uri.driver}.`,
);
}

// No host by default means socket connection
const host_type = postgres_uri.host
? isAbsolute(postgres_uri.host)
? "socket"
: "tcp"
? isAbsolute(postgres_uri.host) ? "socket" : "tcp"
: "socket";

const options = postgres_uri.options
Expand Down Expand Up @@ -347,7 +346,7 @@ function parseOptionsFromUri(connection_string: string): ClientOptions {
}
default: {
throw new ConnectionParamsError(
`Supplied DSN has invalid sslmode '${postgres_uri.sslmode}'`
`Supplied DSN has invalid sslmode '${postgres_uri.sslmode}'`,
);
}
}
Expand All @@ -365,29 +364,31 @@ function parseOptionsFromUri(connection_string: string): ClientOptions {
};
}

const DEFAULT_OPTIONS: Omit<
ClientConfiguration,
"database" | "user" | "hostname"
> & { host: string; socket: string } = {
applicationName: "deno_postgres",
connection: {
attempts: 1,
interval: (previous_interval) => previous_interval + 500,
},
host: "127.0.0.1",
socket: "/tmp",
host_type: "socket",
options: {},
port: 5432,
tls: {
enabled: true,
enforce: false,
caCertificates: [],
},
};
const DEFAULT_OPTIONS:
& Omit<
ClientConfiguration,
"database" | "user" | "hostname"
>
& { host: string; socket: string } = {
applicationName: "deno_postgres",
connection: {
attempts: 1,
interval: (previous_interval) => previous_interval + 500,
},
host: "127.0.0.1",
socket: "/tmp",
host_type: "socket",
options: {},
port: 5432,
tls: {
enabled: true,
enforce: false,
caCertificates: [],
},
};

export function createParams(
params: string | ClientOptions = {}
params: string | ClientOptions = {},
): ClientConfiguration {
if (typeof params === "string") {
params = parseOptionsFromUri(params);
Expand All @@ -408,8 +409,8 @@ export function createParams(
const provided_host = params.hostname ?? pgEnv.hostname;

// If a host is provided, the default connection type is TCP
const host_type =
params.host_type ?? (provided_host ? "tcp" : DEFAULT_OPTIONS.host_type);
const host_type = params.host_type ??
(provided_host ? "tcp" : DEFAULT_OPTIONS.host_type);
if (!["tcp", "socket"].includes(host_type)) {
throw new ConnectionParamsError(`"${host_type}" is not a valid host type`);
}
Expand Down Expand Up @@ -468,36 +469,35 @@ export function createParams(
}
if (Number.isNaN(port) || port === 0) {
throw new ConnectionParamsError(
`"${params.port ?? pgEnv.port}" is not a valid port number`
`"${params.port ?? pgEnv.port}" is not a valid port number`,
);
}

if (host_type === "socket" && params?.tls) {
throw new ConnectionParamsError(
'No TLS options are allowed when host type is set to "socket"'
'No TLS options are allowed when host type is set to "socket"',
);
}
const tls_enabled = !!(params?.tls?.enabled ?? DEFAULT_OPTIONS.tls.enabled);
const tls_enforced = !!(params?.tls?.enforce ?? DEFAULT_OPTIONS.tls.enforce);

if (!tls_enabled && tls_enforced) {
throw new ConnectionParamsError(
"Can't enforce TLS when client has TLS encryption is disabled"
"Can't enforce TLS when client has TLS encryption is disabled",
);
}

// TODO
// Perhaps username should be taken from the PC user as a default?
const connection_options = {
applicationName:
params.applicationName ??
applicationName: params.applicationName ??
pgEnv.applicationName ??
DEFAULT_OPTIONS.applicationName,
connection: {
attempts:
params?.connection?.attempts ?? DEFAULT_OPTIONS.connection.attempts,
interval:
params?.connection?.interval ?? DEFAULT_OPTIONS.connection.interval,
attempts: params?.connection?.attempts ??
DEFAULT_OPTIONS.connection.attempts,
interval: params?.connection?.interval ??
DEFAULT_OPTIONS.connection.interval,
},
database: params.database ?? pgEnv.database,
hostname: host,
Expand All @@ -517,7 +517,7 @@ export function createParams(
assertRequiredOptions(
connection_options,
["applicationName", "database", "hostname", "host_type", "port", "user"],
has_env_access
has_env_access,
);

return connection_options;
Expand Down
4 changes: 2 additions & 2 deletions mod.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ export type {
ClientOptions,
ConnectionOptions,
ConnectionString,
TLSOptions,
DecodeStrategy,
Decoders,
DecodeStrategy,
TLSOptions,
} from "./connection/connection_params.ts";
export type { Session } from "./client.ts";
export type { Notice } from "./connection/message.ts";
Expand Down

1 comment on commit 5f2dcf9

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No typecheck tests failure

This error was most likely caused by incorrect type stripping from the SWC crate

Please report the following failure to https://github.com/denoland/deno with a reproduction of the current commit

Failure log

Please sign in to comment.