chore: fix

Author: ovr

packages/cubejs-api-gateway/src/sql-server.ts

@@ -361,8 +361,8 @@ export class SQLServer {
   }
 
   protected createDefaultCheckSqlAuthFn(options: SQLServerOptions): CheckSQLAuthFn {
-    let allowedUser: string | null = options.sqlUser || getEnv('sqlUser');
-    let allowedPassword: string | null = options.sqlPassword || getEnv('sqlPassword');
+    let allowedUser: string | null = options.sqlUser || getEnv('sqlUser') || null;
+    let allowedPassword: string | null = options.sqlPassword || getEnv('sqlPassword') || null;
 
     if (!getEnv('devMode')) {
       if (!allowedUser) {

packages/cubejs-api-gateway/src/types/strings.ts

@@ -100,15 +100,7 @@ type QueryOrderType =
   'asc' |
   'desc';
 
-/**
- * ApiScopes data type.
- */
-type ApiScopes =
-  'graphql' |
-  'meta' |
-  'data' |
-  'sql' |
-  'jobs';
+export type { ApiScopes } from '@cubejs-backend/shared';
 
 export {
   RequestType,
@@ -121,5 +113,4 @@ export {
   FilterOperator,
   QueryTimeDimensionGranularity,
   QueryOrderType,
-  ApiScopes,
 };

packages/cubejs-athena-driver/src/AthenaDriver.ts

@@ -87,7 +87,7 @@ export class AthenaDriver extends BaseDriver implements DriverInterface {
 
   private athena: Athena;
 
-  private schema: string;
+  private schema: string | undefined;
 
   /**
    * Class constructor.

packages/cubejs-backend-shared/src/env.ts

@@ -2,6 +2,8 @@
 import { get } from 'env-var';
 import { displayCLIWarning } from './cli';
 import { isNativeSupported } from './platform';
+import type { LogLevel } from './logger';
+import type { ApiScopes, ExportBucketType } from './shared-types';
 
 export class InvalidConfiguration extends Error {
   public constructor(key: string, value: any, description: string) {
@@ -163,7 +165,24 @@ const variables = {
   devMode: () => get('CUBEJS_DEV_MODE')
     .default('false')
     .asBoolStrict(),
-  logLevel: () => get('CUBEJS_LOG_LEVEL').asString(),
+  logLevel: (): LogLevel | undefined => {
+    const value = get('CUBEJS_LOG_LEVEL').asString();
+    if (value) {
+      switch (value.toLowerCase()) {
+        case 'trace':
+        case 'info':
+        case 'warn':
+        case 'error':
+          break;
+        // not used, but let's allow
+        case 'debug':
+          break;
+        default:
+          throw new InvalidConfiguration('CUBEJS_LOG_LEVEL', value, 'Must be one of: trace, debug, info, warn, error');
+      }
+    }
+    return value as LogLevel | undefined;
+  },
   port: () => asPortOrSocket(process.env.PORT || '4000', 'PORT'),
   tls: () => get('CUBEJS_ENABLE_TLS')
     .default('false')
@@ -847,27 +866,28 @@ const variables = {
   /**
    * Export bucket storage type.
    */
-  dbExportBucketType: ({
+  dbExportBucketType: <T extends ExportBucketType>({
     supported,
     dataSource,
   }: {
-    supported: ('s3' | 'gcp' | 'azure')[],
+    supported: readonly T[],
     dataSource: string,
-  }) => {
+  }): T | undefined => {
     const val = process.env[
       keyByDataSource('CUBEJS_DB_EXPORT_BUCKET_TYPE', dataSource)
-    ];
+    ] as T | undefined;
     if (
       val &&
       supported &&
-      supported.indexOf(<'s3' | 'gcp' | 'azure'>val) === -1
+      supported.indexOf(val) === -1
     ) {
       throw new TypeError(
         `The ${
           keyByDataSource('CUBEJS_DB_EXPORT_BUCKET_TYPE', dataSource)
         } must be one of the [${supported.join(', ')}].`
       );
     }
+
     return val;
   },
 
@@ -2186,7 +2206,7 @@ const variables = {
   cacheAndQueueDriver: () => get('CUBEJS_CACHE_AND_QUEUE_DRIVER')
     .asString(),
   defaultApiScope: () => get('CUBEJS_DEFAULT_API_SCOPES')
-    .asArray(','),
+    .asArray(',') as ApiScopes[] | undefined,
   jwkUrl: () => get('CUBEJS_JWK_URL')
     .asString(),
   jwtKey: () => get('CUBEJS_JWT_KEY')
@@ -2333,6 +2353,20 @@ const variables = {
 
 type Vars = typeof variables;
 
+export function getEnvFn<T extends keyof Vars>(key: T): Vars[T] {
+  if (key in variables) {
+    return variables[key] as Vars[T];
+  }
+
+  throw new Error(
+    `Unsupported env variable: "${key}"`,
+  );
+}
+
+/**
+ * @deprecated Use getEnvFn instead. TypeScript cannot infer return types correctly
+ * for generic env functions through this wrapper, as ReturnType<> erases generics.
+ */
 export function getEnv<T extends keyof Vars>(key: T, ...args: Parameters<Vars[T]>): ReturnType<Vars[T]> {
   if (key in variables) {
     return (variables[key] as any)(...args);

packages/cubejs-backend-shared/src/index.ts

@@ -1,5 +1,6 @@
 export {
   getEnv,
+  getEnvFn,
   assertDataSource,
   keyByDataSource,
   isDockerImage,

packages/cubejs-backend-shared/src/shared-types.ts

@@ -20,3 +20,16 @@ no-cache — AKA “forceRefresh”
   Returns fresh data from the database, even if it takes minutes and many “Continue wait” intervals
 */
 export type CacheMode = 'stale-if-slow' | 'stale-while-revalidate' | 'must-revalidate' | 'no-cache';
+
+export type ApiScopes =
+  'graphql' |
+  'meta' |
+  'data' |
+  'sql' |
+  'jobs';
+
+export type ExportBucketType =
+  's3' |
+  'gcp' |
+  'gcs' |
+  'azure';

packages/cubejs-bigquery-driver/src/BigQueryDriver.ts

@@ -111,17 +111,19 @@ export class BigQueryDriver extends BaseDriver implements DriverInterface {
       config.dataSource ||
       assertDataSource('default');
 
+    const bigqueryCredentials = getEnv('bigqueryCredentials', { dataSource });
+
     this.options = {
       scopes: [
         'https://www.googleapis.com/auth/bigquery',
         'https://www.googleapis.com/auth/drive',
       ],
       projectId: getEnv('bigqueryProjectId', { dataSource }),
       keyFilename: getEnv('bigqueryKeyFile', { dataSource }),
-      credentials: getEnv('bigqueryCredentials', { dataSource })
+      credentials: bigqueryCredentials
         ? JSON.parse(
           Buffer.from(
-            getEnv('bigqueryCredentials', { dataSource }),
+            bigqueryCredentials,
             'base64',
           ).toString('utf8')
         )

packages/cubejs-clickhouse-driver/src/ClickHouseDriver.ts

@@ -7,6 +7,7 @@
 import {
   getEnv,
   assertDataSource,
+  ExportBucketType,
 } from '@cubejs-backend/shared';
 import {
   BaseDriver,
@@ -35,7 +36,7 @@ import sqlstring from 'sqlstring';
 
 import { transformRow, transformStreamRow } from './HydrationStream';
 
-const SUPPORTED_BUCKET_TYPES = ['s3'];
+const SUPPORTED_BUCKET_TYPES: ExportBucketType[] = ['s3'];
 
 const ClickhouseTypeToGeneric: Record<string, string> = {
   enum: 'text',
@@ -94,23 +95,23 @@ export interface ClickHouseDriverOptions {
 }
 
 interface ClickhouseDriverExportRequiredAWS {
-  bucketType: 's3',
+  bucketType: ExportBucketType,
   bucketName: string,
   region: string,
 }
 
 interface ClickhouseDriverExportKeySecretAWS extends ClickhouseDriverExportRequiredAWS {
-  keyId: string,
-  secretKey: string,
+  keyId?: string,
+  secretKey?: string,
 }
 
 interface ClickhouseDriverExportAWS extends ClickhouseDriverExportKeySecretAWS {
 }
 
 type ClickHouseDriverConfig = {
   url: string,
-  username: string,
-  password: string,
+  username?: string,
+  password?: string,
   readOnly: boolean,
   database: string,
   requestTimeout: number,
@@ -505,7 +506,7 @@ export class ClickHouseDriver extends BaseDriver implements DriverInterface {
   protected getExportBucket(
     dataSource: string,
   ): ClickhouseDriverExportAWS | null {
-    const requiredExportBucket: ClickhouseDriverExportRequiredAWS = {
+    const requiredExportBucket: Partial<ClickhouseDriverExportRequiredAWS> = {
       bucketType: getEnv('dbExportBucketType', {
         supported: SUPPORTED_BUCKET_TYPES,
         dataSource,
@@ -514,7 +515,7 @@ export class ClickHouseDriver extends BaseDriver implements DriverInterface {
       region: getEnv('dbExportBucketAwsRegion', { dataSource }),
     };
 
-    const exportBucket: ClickhouseDriverExportAWS = {
+    const exportBucket: Partial<ClickhouseDriverExportAWS> = {
       ...requiredExportBucket,
       keyId: getEnv('dbExportBucketAwsKey', { dataSource }),
       secretKey: getEnv('dbExportBucketAwsSecret', { dataSource }),
@@ -536,7 +537,7 @@ export class ClickHouseDriver extends BaseDriver implements DriverInterface {
         );
       }
 
-      return exportBucket;
+      return exportBucket as ClickhouseDriverExportAWS;
     }
 
     return null;
@@ -620,13 +621,13 @@ export class ClickHouseDriver extends BaseDriver implements DriverInterface {
 
     await this.command(formattedQuery);
 
+    const { keyId, secretKey, region } = this.config.exportBucket;
     const csvFile = await this.extractUnloadedFilesFromS3(
       {
-        credentials: {
-          accessKeyId: this.config.exportBucket.keyId,
-          secretAccessKey: this.config.exportBucket.secretKey,
-        },
-        region: this.config.exportBucket.region,
+        credentials: keyId && secretKey
+          ? { accessKeyId: keyId, secretAccessKey: secretKey }
+          : undefined,
+        region,
       },
       bucketName,
       exportPrefix,

packages/cubejs-databricks-jdbc-driver/src/DatabricksDriver.ts

@@ -5,7 +5,7 @@
  */
 
 import fetch from 'node-fetch';
-import { assertDataSource, getEnv, LoggerFn } from '@cubejs-backend/shared';
+import { assertDataSource, getEnv, getEnvFn, LoggerFn, ExportBucketType } from '@cubejs-backend/shared';
 import {
   DatabaseStructure,
   DriverCapabilities,
@@ -25,7 +25,7 @@ import {
   resolveJDBCDriver
 } from './helpers';
 
-const SUPPORTED_BUCKET_TYPES = ['s3', 'gcs', 'azure'];
+const SUPPORTED_BUCKET_TYPES = ['s3', 'gcs', 'azure'] as const;
 
 export type DatabricksDriverConfiguration = JDBCDriverConfiguration &
   {
@@ -37,7 +37,7 @@ export type DatabricksDriverConfiguration = JDBCDriverConfiguration &
     /**
      * Export bucket type.
      */
-    bucketType?: string,
+    bucketType?: 's3' | 'gcs' | 'azure',
 
     /**
      * Export bucket path.
@@ -204,10 +204,14 @@ export class DatabricksDriver extends JDBCDriver {
       assertDataSource('default');
 
     let showSparkProtocolWarn = false;
-    let url: string =
+    let url =
       conf?.url ||
       getEnv('databricksUrl', { dataSource }) ||
       getEnv('jdbcUrl', { dataSource });
+    if (!url) {
+      throw new Error('url is required for Databricks');
+    }
+
     if (url.indexOf('jdbc:spark://') !== -1) {
       showSparkProtocolWarn = true;
       url = url.replace('jdbc:spark://', 'jdbc:databricks://');
@@ -265,7 +269,7 @@ export class DatabricksDriver extends JDBCDriver {
       // common export bucket config
       bucketType:
         conf?.bucketType ||
-        getEnv('dbExportBucketType', { supported: SUPPORTED_BUCKET_TYPES, dataSource }),
+        getEnvFn('dbExportBucketType')({ supported: SUPPORTED_BUCKET_TYPES, dataSource }),
       exportBucket:
         conf?.exportBucket ||
         getEnv('dbExportBucket', { dataSource }),
@@ -759,7 +763,7 @@ export class DatabricksDriver extends JDBCDriver {
    * export bucket data.
    */
   public async unload(tableName: string, options: UnloadOptions) {
-    if (!SUPPORTED_BUCKET_TYPES.includes(this.config.bucketType as string)) {
+    if (!this.config.bucketType || !SUPPORTED_BUCKET_TYPES.includes(this.config.bucketType)) {
       throw new Error(`Unsupported export bucket type: ${
         this.config.bucketType
       }`);

packages/cubejs-duckdb-driver/src/DuckDBDriver.ts

@@ -8,7 +8,7 @@ import {
   TableStructure,
   TableColumnQueryResult,
 } from '@cubejs-backend/base-driver';
-import { getEnv } from '@cubejs-backend/shared';
+import { assertDataSource, getEnv } from '@cubejs-backend/shared';
 import { promisify } from 'util';
 import * as stream from 'stream';
 import { Connection, Database } from 'duckdb';
@@ -40,15 +40,19 @@ const DuckDBToGenericType: Record<string, GenericDataBaseType> = {
 };
 
 export class DuckDBDriver extends BaseDriver implements DriverInterface {
+  protected readonly config: DuckDBDriverConfiguration & { dataSource: string };
+
   protected initPromise: Promise<InitPromise> | null = null;
 
-  private readonly schema: string;
+  private readonly schema: string | undefined;
 
   public constructor(
-    protected readonly config: DuckDBDriverConfiguration = {},
+    config: DuckDBDriverConfiguration = {},
   ) {
     super();
 
+    const dataSource = config.dataSource || assertDataSource('default');
+    this.config = { ...config, dataSource };
     this.schema = this.config.schema || getEnv('duckdbSchema', this.config);
   }