fix: Use the right Metadata for grpc-web. Fixes #270. (#271)

stephenh · Apr 7, 2021 · 640e645 · 640e645
1 parent 51e5386
commit 640e645
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 12 deletions.
diff --git a/integration/grpc-web-no-streaming-observable/example.ts b/integration/grpc-web-no-streaming-observable/example.ts
@@ -5,7 +5,6 @@ import { grpc } from '@improbable-eng/grpc-web';
 import { Observable } from 'rxjs';
 import { BrowserHeaders } from 'browser-headers';
 import { take } from 'rxjs/operators';
-import { Metadata } from 'grpc';
 
 export const protobufPackage = 'rpx';
 
@@ -355,7 +354,7 @@ export const Empty = {
  * but with the streaming method removed.
  */
 export interface DashState {
-  UserSettings(request: DeepPartial<Empty>, metadata?: Metadata): Observable<DashUserSettingsState>;
+  UserSettings(request: DeepPartial<Empty>, metadata?: grpc.Metadata): Observable<DashUserSettingsState>;
 }
 
 export class DashStateClientImpl implements DashState {

diff --git a/integration/grpc-web-no-streaming/example.ts b/integration/grpc-web-no-streaming/example.ts
@@ -3,7 +3,6 @@ import { util, configure, Writer, Reader } from 'protobufjs/minimal';
 import * as Long from 'long';
 import { grpc } from '@improbable-eng/grpc-web';
 import { BrowserHeaders } from 'browser-headers';
-import { Metadata } from 'grpc';
 
 export const protobufPackage = 'rpx';
 
@@ -353,7 +352,7 @@ export const Empty = {
  * but with the streaming method removed.
  */
 export interface DashState {
-  UserSettings(request: DeepPartial<Empty>, metadata?: Metadata): Promise<DashUserSettingsState>;
+  UserSettings(request: DeepPartial<Empty>, metadata?: grpc.Metadata): Promise<DashUserSettingsState>;
 }
 
 export class DashStateClientImpl implements DashState {

diff --git a/integration/grpc-web/example-test.ts b/integration/grpc-web/example-test.ts
@@ -0,0 +1,14 @@
+import { DashStateClientImpl } from './example';
+
+describe('grpc-web', () => {
+  it('at least compiles', () => {
+    // TODO move the hand-run `client-ts` integration into here, but for now
+    // at least check that things compile
+    const rpc = {
+      unary: jest.fn(),
+      invoke: jest.fn(),
+    };
+    const client = new DashStateClientImpl(rpc);
+    client.UserSettings({});
+  });
+});
diff --git a/integration/grpc-web/example.ts b/integration/grpc-web/example.ts
@@ -5,7 +5,6 @@ import { grpc } from '@improbable-eng/grpc-web';
 import { Observable } from 'rxjs';
 import { BrowserHeaders } from 'browser-headers';
 import { share } from 'rxjs/operators';
-import { Metadata } from 'grpc';
 
 export const protobufPackage = 'rpx';
 
@@ -731,8 +730,8 @@ export const Empty = {
 };
 
 export interface DashState {
-  UserSettings(request: DeepPartial<Empty>, metadata?: Metadata): Promise<DashUserSettingsState>;
-  ActiveUserSettingsStream(request: DeepPartial<Empty>, metadata?: Metadata): Observable<DashUserSettingsState>;
+  UserSettings(request: DeepPartial<Empty>, metadata?: grpc.Metadata): Promise<DashUserSettingsState>;
+  ActiveUserSettingsStream(request: DeepPartial<Empty>, metadata?: grpc.Metadata): Observable<DashUserSettingsState>;
 }
 
 export class DashStateClientImpl implements DashState {
@@ -805,9 +804,9 @@ export const DashStateActiveUserSettingsStreamDesc: UnaryMethodDefinitionish = {
  * ----------------------
  */
 export interface DashAPICreds {
-  Create(request: DeepPartial<DashAPICredsCreateReq>, metadata?: Metadata): Promise<DashCred>;
-  Update(request: DeepPartial<DashAPICredsUpdateReq>, metadata?: Metadata): Promise<DashCred>;
-  Delete(request: DeepPartial<DashAPICredsDeleteReq>, metadata?: Metadata): Promise<DashCred>;
+  Create(request: DeepPartial<DashAPICredsCreateReq>, metadata?: grpc.Metadata): Promise<DashCred>;
+  Update(request: DeepPartial<DashAPICredsUpdateReq>, metadata?: grpc.Metadata): Promise<DashCred>;
+  Delete(request: DeepPartial<DashAPICredsDeleteReq>, metadata?: grpc.Metadata): Promise<DashCred>;
 }
 
 export class DashAPICredsClientImpl implements DashAPICreds {

diff --git a/src/generate-services.ts b/src/generate-services.ts
@@ -21,7 +21,6 @@ import { Context } from './context';
 const hash = imp('hash*object-hash');
 const dataloader = imp('DataLoader*dataloader');
 const Reader = imp('Reader@protobufjs/minimal');
-const Metadata = imp('Metadata@grpc');
 
 /**
  * Generates an interface for `serviceDesc`.
@@ -67,8 +66,10 @@ export function generateService(
 
     // Use metadata as last argument for interface only configuration
     if (options.outputClientImpl === 'grpc-web') {
-      params.push(code`metadata?: ${Metadata}`);
+      // We have to use grpc.Metadata where grpc will come from @improbable-eng
+      params.push(code`metadata?: grpc.Metadata`);
     } else if (options.addGrpcMetadata) {
+      const Metadata = imp('Metadata@grpc');
       const q = options.addNestjsRestParameter ? '' : '?';
       params.push(code`metadata${q}: ${Metadata}`);
     }

diff --git a/tests/options-test.ts b/tests/options-test.ts
@@ -32,4 +32,12 @@ describe('options', () => {
       }
     `);
   });
+
+  it('can set outputJsonMethods with nestJs=true', () => {
+    const options = optionsFromParameter('outputClientImpl=grpc-web,addGrpcMetadata=false');
+    expect(options).toMatchObject({
+      outputClientImpl: 'grpc-web',
+      addGrpcMetadata: false,
+    });
+  });
 });