fix: import (#7)

Author: czy88840616

package.json

@@ -29,9 +29,9 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "^14.0.11",
-    "@types/jest": "^26.0.22",
     "@midwayjs/cli": "^1.0.0",
+    "@types/jest": "^26.0.22",
+    "@types/node": "^14.0.11",
     "mwts": "^1.0.5"
   },
   "dependencies": {

src/compiler/index.ts

@@ -20,9 +20,18 @@ import './handlebars/method-generate-helper';
 
 import { IGenOptions } from '../types';
 
+function formatImport(item: string) {
+  const prefix = /^\./.test(item) ? '' : './';
+  const arr = item.split('/');
+  const filename = arr[arr.length - 1];
+  return prefix + filename.replace('.proto', '');
+}
+
 /** Set Compiler */
 export class Compiler {
   constructor(private readonly options: IGenOptions) {}
+  private protoFiles: string[] = [];
+  private protoInfo = {};
 
   private resolveRootPath(root: Root): void {
     const paths = this.options.path;
@@ -105,7 +114,7 @@ export class Compiler {
     }
   }
 
-  private output(file: string, pkg: string, tmpl: string): void {
+  private output(file: string, tmpl: string): void {
     const root = new Root();
 
     this.resolveRootPath(root);
@@ -119,7 +128,37 @@ export class Compiler {
 
     this.walkTree(root);
 
-    const results = compile(tmpl)(root);
+    let results = compile(tmpl)(root);
+    const packageArr = [];
+
+    // 处理继承问题
+    results = results.replace("'@midwayjs/grpc';", matched => {
+      return [matched]
+        .concat(
+          this.protoInfo[file].imports.map(item => {
+            packageArr.push(this.findPackage(item));
+            return `import { ${this.findPackage(item)} } from '${formatImport(
+              item
+            )}';`;
+          })
+        )
+        .join('\n');
+    });
+
+    // 移除继承的代码
+    for (const name of packageArr) {
+      const regexp = new RegExp(
+        `\\/\\*.+package ${name} start[\\s\\S]*${name} end \\*\\/`,
+        'gm'
+      );
+      results = results.replace(regexp, '');
+    }
+
+    // 清理空导入
+    results = results.replace(/import { {2}} from '.+';\n/, '');
+
+    // 清理最后的换行
+    results = results.replace(/\n+$/, '\n');
 
     const outputFile = this.options.output
       ? join(this.options.output, basename(file))
@@ -132,22 +171,6 @@ export class Compiler {
     outputFileSync(outputPath, results, 'utf8');
   }
 
-  private generate(path: string, pkg: string): void {
-    const hbTemplate = resolve(__dirname, '../../template.hbs');
-
-    if (!existsSync(hbTemplate)) {
-      throw new Error(`Template ${hbTemplate} is not found`);
-    }
-
-    const tmpl = readFileSync(hbTemplate, 'utf8');
-
-    if (this.options.verbose) {
-      console.log(chalk.blueBright('-- found: ') + chalk.gray(path));
-    }
-
-    this.output(path, pkg, tmpl);
-  }
-
   private getProtoFiles(pkg: string): void {
     if (!existsSync(pkg)) {
       throw new Error(`Directory ${pkg} is not exist`);
@@ -166,7 +189,10 @@ export class Compiler {
       if (stat.isDirectory()) {
         this.getProtoFiles(filename);
       } else if (filename.indexOf(this.options.target.join()) > -1) {
-        this.generate(filename, pkg);
+        if (this.options.verbose) {
+          console.log(chalk.blueBright('-- found: ') + chalk.gray(filename));
+        }
+        this.protoFiles.push(filename);
       }
     }
   }
@@ -177,5 +203,43 @@ export class Compiler {
         this.getProtoFiles(pkg);
       }
     });
+
+    // 提前分析 package 和导入的情况
+    for (const filename of this.protoFiles) {
+      this.protoInfo[filename] = {};
+      const originFile = readFileSync(filename, 'utf8');
+      const regex1 = /import\s"(.+)";/g;
+      let array1;
+      const result = [];
+      while ((array1 = regex1.exec(originFile)) !== null) {
+        result.push(array1[1]);
+      }
+      const packageRegexp = /package\s+(.+);/;
+      const arr = packageRegexp.exec(originFile);
+      this.protoInfo[filename] = {
+        packageName: arr[1],
+        imports: result,
+      };
+    }
+
+    const hbTemplate = resolve(__dirname, '../../template.hbs');
+    if (!existsSync(hbTemplate)) {
+      throw new Error(`Template ${hbTemplate} is not found`);
+    }
+    const tmpl = readFileSync(hbTemplate, 'utf8');
+
+    for (const filename of this.protoFiles) {
+      this.output(filename, tmpl);
+    }
+  }
+
+  findPackage(p: string): string {
+    p = p.replace(/\.+\//g, '');
+    for (const key of Object.keys(this.protoInfo)) {
+      if (key.lastIndexOf(p) !== -1) {
+        return this.protoInfo[key].packageName;
+      }
+    }
+    return '';
   }
 }

template.hbs

@@ -24,11 +24,13 @@ import * as grpc from '@midwayjs/grpc';
 {{#if comment}}
   {{comment}}
 {{/if}}
+/* package {{@key}} start */
 export namespace {{@key}} {
   {{> selector }}
 }
-{{/inline}}
+/* package {{@key}} end */
 
+{{/inline}}
 {{#*inline "service"}}
 {{#each methods}}
 {{else}}

test/fixtures/issue999/base.proto

@@ -0,0 +1,12 @@
+syntax="proto3";
+package base; //协议包名
+
+option go_package = "base";
+
+import "proto/gogo/gogo.proto";
+import "abc.proto";
+
+option (gogoproto.goproto_enum_prefix_all) = false;
+message Void {
+
+}

test/fixtures/issue999/liveroom.proto

@@ -0,0 +1,19 @@
+syntax = "proto3";
+package liveroom;  //协议包名
+option  go_package = "liveroom";
+import "base.proto";
+import "proto/gogo/gogo.proto";
+service LiveRoomService {
+// 玩家离开房间
+   rpc LeaveRoom (GetRoomReq) returns (base.Void) {
+      option (kitproto.id) = 4;
+   }
+
+   rpc AddRoom (GetRoomReq) returns (gogo.HelloReply) {
+      option (kitproto.id) = 4;
+   }
+}
+
+message GetRoomReq {
+   optional string   id              = 1[(gogoproto.nullable) = false];
+}

test/fixtures/issue999/proto/gogo/gogo.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+package gogo;  //协议包名
+
+// The greeting service definition.
+service Greeter {
+  // Sends a greeting
+  rpc SayHello (HelloRequest) returns (HelloReply) {}
+}
+
+// The request message containing the user's name.
+message HelloRequest {
+  string name = 1;
+}
+
+// The response message containing the greetings
+message HelloReply {
+  string message = 1;
+}

test/index.test.ts

@@ -72,4 +72,35 @@ describe('/test/index.test.ts', () => {
 
     await remove(join(__dirname, './fixtures/keep_case/domain'));
   });
+
+  it('test fix issue 999', async () => {
+    const compiler = new Compiler({
+      path: ['test/fixtures/issue999'],
+      target: ['.proto'],
+      ignore: ['node_modules', 'dist'],
+      output: 'test/fixtures/issue999/domain',
+      keepCase: true,
+    });
+
+    compiler.compile();
+    expect(existsSync(join(__dirname, './fixtures/issue999/domain/base.ts'))).toBeTruthy();
+    expect(existsSync(join(__dirname, './fixtures/issue999/domain/gogo.ts'))).toBeTruthy();
+    expect(existsSync(join(__dirname, './fixtures/issue999/domain/liveroom.ts'))).toBeTruthy();
+
+    let content = readFileSync(join(__dirname, './fixtures/issue999/domain/base.ts'), 'utf8');
+    expect(content.includes('export namespace base {')).toBeTruthy();
+    expect(content.includes('import { gogo } from \'./gogo\';')).toBeTruthy();
+    expect(!content.includes('namespace gogo')).toBeTruthy();
+
+    content = readFileSync(join(__dirname, './fixtures/issue999/domain/gogo.ts'), 'utf8');
+    expect(content.includes('sayHello(data: HelloRequest): Promise<HelloReply>;')).toBeTruthy();
+
+    content = readFileSync(join(__dirname, './fixtures/issue999/domain/liveroom.ts'), 'utf8');
+    expect(content.includes('import { gogo } from \'./gogo\';')).toBeTruthy();
+    expect(content.includes('import { base } from \'./base\';')).toBeTruthy();
+    expect(!content.includes('namespace base')).toBeTruthy();
+    expect(!content.includes('namespace gogo')).toBeTruthy();
+
+    await remove(join(__dirname, './fixtures/issue999/domain'));
+  });
 });