fix: add fallback, if fsPath results in undefined/ error (AnWeber/htt…

…pbook#43)
AnWeber · Jan 30, 2022 · 63241b5 · 63241b5
1 parent 9bbd08e
commit 63241b5
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 26 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,12 +1,9 @@
-## 4.10.0 (2022-01-27)
-
-#### Features
+## Unreleased
 
-- use Host Header as Url Prefix (#189)
-- add cookie to userSessionStore instead cookieStore
-- `# @loop` allows actions before execution of the loop (e.g. ' # @ref ...`)
-- use all dotenv files between httpfile directory and rootDir (#174)
+#### Fix
 
+- add fallback, if fsPath results in undefined/ error (AnWeber/httpbook#43)
+- Error parsing grpc URL starting with grpc fixed (mistaken for protocol)
 
 ## 4.10.0 (2022-01-27)
 

diff --git a/src/cli/initCliProvider.ts b/src/cli/initCliProvider.ts
@@ -36,12 +36,18 @@ function initFileProvider(): void {
   };
   fileProvider.readFile = async (fileName: models.PathLike, encoding: models.FileEncoding): Promise<string> => {
     const file = fileProvider.fsPath(fileName);
-    return fs.readFile(file, encoding);
+    if (file) {
+      return fs.readFile(file, encoding);
+    }
+    throw new Error('No valid path for cli');
   };
   fileProvider.readBuffer = async (fileName: models.PathLike) => {
     const file = fileProvider.fsPath(fileName);
-    const stream = createReadStream(file);
-    return toBuffer(stream);
+    if (file) {
+      const stream = createReadStream(file);
+      return toBuffer(stream);
+    }
+    throw new Error('No valid path for cli');
   };
   fileProvider.writeBuffer = (fileName: models.PathLike, buffer: Buffer) =>
     fs.writeFile(fileProvider.toString(fileName), buffer);

diff --git a/src/models/fileProvider.ts b/src/models/fileProvider.ts
@@ -23,6 +23,6 @@ export interface FileProvider {
   writeBuffer(fileName: PathLike, buffer: Buffer): Promise<void>;
   readdir: (dirname: PathLike) => Promise<string[]>;
   hasExtension(fileName: PathLike, extension: string): boolean;
-  fsPath(fileName: PathLike): string;
+  fsPath(fileName: PathLike): string | undefined;
   toString(fileName: PathLike): string;
 }
diff --git a/src/parser/protoHttpRegionParser.ts b/src/parser/protoHttpRegionParser.ts
@@ -1,4 +1,4 @@
-import { fileProvider, log, userInteractionProvider } from '../io';
+import * as io from '../io';
 import * as models from '../models';
 import * as utils from '../utils';
 import { ParserRegex } from './parserRegex';
@@ -76,7 +76,17 @@ export class ProtoImportAction implements models.HttpRegionAction {
       definition.packageDefinition = await utils.replaceFilePath(
         this.protoDefinition.fileName,
         context,
-        (path: models.PathLike) => load(fileProvider.fsPath(path), options)
+        async (path: models.PathLike) => {
+          const fsPath = io.fileProvider.fsPath(path);
+          if (fsPath) {
+            return await load(fsPath, options);
+          }
+          const message = `file ${path} has not scheme file`;
+          io.userInteractionProvider.showWarnMessage?.(message);
+          io.log.warn(message);
+
+          return undefined;
+        }
       );
       if (definition.packageDefinition) {
         definition.grpcObject = loadPackageDefinition(definition.packageDefinition);
@@ -97,8 +107,8 @@ export class ProtoImportAction implements models.HttpRegionAction {
       Object.assign(options, await utils.evalExpression(`{${optionsScript}}`, context));
     } catch (err) {
       const message = `proto-loader options convert failed: ${optionsScript}`;
-      userInteractionProvider.showWarnMessage?.(message);
-      log.warn(message, err);
+      io.userInteractionProvider.showWarnMessage?.(message);
+      io.log.warn(message, err);
     }
     return options;
   }

diff --git a/src/utils/configUtils.ts b/src/utils/configUtils.ts
@@ -24,22 +24,23 @@ export const defaultConfigFiles = [
 ];
 
 async function loadFileConfig(rootDir: PathLike): Promise<EnvironmentConfig | undefined> {
-  let fileConfigPath: PathLike | undefined;
+  let fileConfigPath: string | undefined;
   for (const fileName of defaultConfigFiles) {
     const resolvedPath = fileName && fileProvider.joinPath(rootDir, fileName);
     if (resolvedPath && (await fileProvider.exists(resolvedPath))) {
-      fileConfigPath = resolvedPath;
+      fileConfigPath = fileProvider.fsPath(resolvedPath);
       break;
     }
   }
   if (fileConfigPath) {
-    const fsConfigPath = fileProvider.fsPath(fileConfigPath);
     const fsRoot = fileProvider.fsPath(rootDir);
-    const fileConfig = loadModule<EnvironmentConfig | (() => EnvironmentConfig)>(fsConfigPath, fsRoot, true);
-    if (typeof fileConfig === 'function') {
-      return fileConfig();
+    if (fsRoot) {
+      const fileConfig = loadModule<EnvironmentConfig | (() => EnvironmentConfig)>(fileConfigPath, fsRoot, true);
+      if (typeof fileConfig === 'function') {
+        return fileConfig();
+      }
+      return fileConfig;
     }
-    return fileConfig;
   }
   return undefined;
 }

diff --git a/src/utils/fsUtils.ts b/src/utils/fsUtils.ts
@@ -59,8 +59,9 @@ export async function findRootDirOfFile(
   ...files: Array<string>
 ): Promise<PathLike | undefined> {
   let file = filename;
-  if (!(await fileProvider.isAbsolute(filename)) && workingDir) {
-    file = fileProvider.joinPath(workingDir, fileProvider.fsPath(filename));
+  const fsPath = fileProvider.fsPath(filename);
+  if (!(await fileProvider.isAbsolute(filename)) && workingDir && fsPath) {
+    file = fileProvider.joinPath(workingDir, fsPath);
   }
   const dirName = fileProvider.dirname(file);
   const dir = await findRootDir(dirName, ...files);

diff --git a/src/utils/moduleUtils.ts b/src/utils/moduleUtils.ts
@@ -83,7 +83,7 @@ export async function runScript(
     deleteVariable?: (key: string) => void;
   }
 ): Promise<Record<string, unknown>> {
-  const filename = fileProvider.fsPath(options.fileName);
+  const filename = toModuleFilename(options.fileName);
 
   const mod = createModule(filename);
 
@@ -102,7 +102,7 @@ export async function runScript(
       log.warn(`requireUncached is deprecated. It can no longer be supported due to esm conversion.`);
       const dirName = fileProvider.dirname(filename);
       if (dirName) {
-        clearModule(id, fileProvider.fsPath(dirName));
+        clearModule(id, toModuleFilename(dirName));
       }
       return mod.require(id);
     },
@@ -131,6 +131,9 @@ export async function runScript(
   }
   return result;
 }
+function toModuleFilename(fileName: PathLike) {
+  return fileProvider.fsPath(fileName) || fileProvider.toString(fileName);
+}
 
 function deleteVariables(contextKeys: string[], context: vm.Context, deleteVariable?: (key: string) => void) {
   if (deleteVariable) {