STITCH-3383 add client sdk FunctionCredential (#329)

jsflax · web-flow · commit 0c2617d298b1 · 2019-11-05T18:41:38.000Z
diff --git a/packages/browser/coretest/__tests__/StitchAppClientIntTests.ts b/packages/browser/coretest/__tests__/StitchAppClientIntTests.ts
@@ -21,6 +21,8 @@ import {
   Anon,
   App,
   AppResource,
+  CustomFunctionProvider,
+  CustomFunctionProviderConfig,
   CustomProvider,
   CustomProviderConfig,
   StitchFunction,
@@ -33,12 +35,15 @@ import {
   AnonymousCredential,
   CustomAuthProvider,
   CustomCredential,
+  FunctionAuthProvider,
+  FunctionCredential,
   MemoryStorage,
   StitchClientError,
   StitchClientErrorCode,
   UserPasswordAuthProvider,
   UserPasswordCredential,
-  UserType
+  UserType,
+  StitchServiceError
 } from "mongodb-stitch-core-sdk";
 
 const harness = new BaseStitchBrowserIntTestHarness();
@@ -520,6 +525,62 @@ describe("StitchAppClient", () => {
     expect(client.auth.listUsers().length).toBe(2);
   });
 
+  it("should authenticate using a custom function", async () => {
+    const { app: appResponse, appResource: app } = await harness.createApp();
+
+    const def = await app.functions.create(new StitchFunction(
+        "funkyAuth",
+        false,
+        `
+        exports = function(payload) {
+            return payload.id;
+        }`
+    ));
+
+    await harness.addProvider(app, new CustomFunctionProvider(new CustomFunctionProviderConfig(def.id!!, def.name)));
+
+    const client = harness.getAppClient(appResponse);
+
+    const id = "123abc";
+    const user = await client.auth.loginWithCredential(new FunctionCredential({id}));
+
+    expect(user).toBeDefined();
+
+    expect(user.id).toBeDefined();
+    expect(user.identities[0].id).toBeDefined();
+    expect(id).toEqual(user.identities[0].id);
+    expect(FunctionAuthProvider.DEFAULT_NAME).toEqual(user.loggedInProviderName);
+    expect(FunctionAuthProvider.TYPE).toEqual(user.loggedInProviderType);
+    expect(UserType.Normal).toEqual(user.userType);
+    expect(FunctionAuthProvider.TYPE).toEqual(user.identities[0].providerType);
+    expect(client.auth.isLoggedIn).toBeTruthy();
+  });
+
+  it("should fail authentication using a custom function", async () => {
+    const { app: appResponse, appResource: app } = await harness.createApp();
+
+    const def = await app.functions.create(new StitchFunction(
+        "funkyAuth",
+        false,
+        `
+        exports = function(payload) {
+            return 0;
+        }`
+    ));
+
+    await harness.addProvider(app, new CustomFunctionProvider(new CustomFunctionProviderConfig(def.id!!, def.name)));
+
+    const client = harness.getAppClient(appResponse);
+
+    const id = "123abc";
+    try {
+      await client.auth.loginWithCredential(new FunctionCredential({id}));
+      fail("loginWithCredential with FunctionCredential should have failed");
+    } catch (error) {
+      expect(error instanceof StitchServiceError).toBeTruthy();
+    }
+  });
+
   it("should call reset password function", async () => {
     const { app: appResponse, appResource: app } = await harness.createApp();
     
diff --git a/packages/core/admin-client/src/authProviders/ProviderConfigs.ts b/packages/core/admin-client/src/authProviders/ProviderConfigs.ts
@@ -66,6 +66,21 @@ class UserpassProvider extends Provider {
   }
 }
 
+class CustomFunctionProviderConfig {
+  public constructor(
+    @jsonProperty("authFunctionId") readonly authFunctionId: string,
+    @jsonProperty("authFunctionName") readonly authFunctionName: string
+  ) {}
+}
+
+class CustomFunctionProvider extends Provider {
+  public readonly type = "custom-function"
+
+  public constructor(public readonly config: CustomFunctionProviderConfig) {
+    super();
+  }
+ }
+
 class CustomProviderConfig {
   public constructor(@jsonProperty("signingKey") readonly signingKey: string) {} 
 }
@@ -85,5 +100,7 @@ export {
   UserpassProviderConfig, 
   UserpassProvider, 
   CustomProviderConfig, 
-  CustomProvider
+  CustomProvider,
+  CustomFunctionProviderConfig,
+  CustomFunctionProvider
 };
diff --git a/packages/core/admin-client/src/index.ts b/packages/core/admin-client/src/index.ts
@@ -21,8 +21,10 @@ import { AuthProviderResource, AuthProvidersResource } from "./authProviders/Aut
 import {
   AnonProviderConfig, 
   ApiKey,
+  CustomFunctionProvider,
+  CustomFunctionProviderConfig,
   CustomProvider, 
-  CustomProviderConfig, 
+  CustomProviderConfig,
   Provider,
   UserpassProvider, 
   UserpassProviderConfig
@@ -110,6 +112,8 @@ export {
   ServicesResource,
   CustomProviderConfig, 
   CustomProvider,
+  CustomFunctionProvider,
+  CustomFunctionProviderConfig,
   Rule,
   RuleResource,
   RulesResource,
diff --git a/packages/core/sdk/src/auth/providers/function/FunctionAuthProvider.ts b/packages/core/sdk/src/auth/providers/function/FunctionAuthProvider.ts
@@ -0,0 +1,24 @@
+/**
+ * Copyright 2018-present MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** @hidden */
+export default class FunctionAuthProvider {
+
+	public static TYPE = "custom-function";
+	public static DEFAULT_NAME = "custom-function";
+	private constructor() {}
+  }
+  
diff --git a/packages/core/sdk/src/auth/providers/function/FunctionCredential.ts b/packages/core/sdk/src/auth/providers/function/FunctionCredential.ts
@@ -0,0 +1,42 @@
+/**
+ * Copyright 2018-present MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import ProviderCapabilities from "../../ProviderCapabilities";
+import StitchCredential from "../../StitchCredential";
+import FunctionAuthProvider from "./FunctionAuthProvider";
+
+/** 
+ * A credential which can be used to log in as a Stitch user
+ * using the Function authentication provider.
+ */
+export default class FunctionCredential implements StitchCredential {
+
+  public get providerCapabilities(): ProviderCapabilities {
+    return new ProviderCapabilities(false);
+  }
+  public readonly providerName: string;
+  public readonly providerType = FunctionAuthProvider.TYPE;
+
+  public readonly material: { [key: string]: string };
+
+  constructor(
+    payload: { [key: string]: string },
+    providerName: string = FunctionAuthProvider.DEFAULT_NAME
+  ) {
+    this.providerName = providerName;
+    this.material = payload;
+  }
+}
diff --git a/packages/core/sdk/src/index.ts b/packages/core/sdk/src/index.ts
@@ -42,6 +42,8 @@ import CustomAuthProvider from "./auth/providers/custom/CustomAuthProvider";
 import CustomCredential from "./auth/providers/custom/CustomCredential";
 import FacebookAuthProvider from "./auth/providers/facebook/FacebookAuthProvider";
 import FacebookCredential from "./auth/providers/facebook/FacebookCredential";
+import FunctionAuthProvider from "./auth/providers/function/FunctionAuthProvider";
+import FunctionCredential from "./auth/providers/function/FunctionCredential";
 import GoogleAuthProvider from "./auth/providers/google/GoogleAuthProvider";
 import GoogleCredential from "./auth/providers/google/GoogleCredential";
 import StitchAuthResponseCredential from "./auth/providers/internal/StitchAuthResponseCredential";
@@ -108,6 +110,8 @@ export {
   CustomCredential,
   FacebookAuthProvider,
   FacebookCredential,
+  FunctionAuthProvider,
+  FunctionCredential,
   GoogleAuthProvider,
   GoogleCredential,
   ServerApiKeyAuthProvider,
diff --git a/packages/react-native/coretest/__tests__/StitchAppClientIntTests.ts b/packages/react-native/coretest/__tests__/StitchAppClientIntTests.ts
@@ -19,6 +19,8 @@ import {
   Anon,
   App,
   AppResource,
+  CustomFunctionProvider,
+  CustomFunctionProviderConfig,
   CustomProvider,
   CustomProviderConfig,
   StitchFunction,
@@ -31,12 +33,15 @@ import {
   AnonymousCredential,
   CustomAuthProvider,
   CustomCredential,
+  FunctionAuthProvider,
+  FunctionCredential,
   MemoryStorage,
   StitchClientError,
   StitchClientErrorCode,
   UserPasswordAuthProvider,
   UserPasswordCredential,
-  UserType
+  UserType,
+  StitchServiceError
 } from "mongodb-stitch-core-sdk";
 import { 
   RNAsyncStorage,
@@ -520,6 +525,62 @@ describe("StitchAppClient", () => {
     expect(client.auth.listUsers().length).toBe(2);
   });
 
+  it("should authenticate using a custom function", async () => {
+    const { app: appResponse, appResource: app } = await harness.createApp();
+
+    const def = await app.functions.create(new StitchFunction(
+        "funkyAuth",
+        false,
+        `
+        exports = function(payload) {
+            return payload.id;
+        }`
+    ));
+
+    await harness.addProvider(app, new CustomFunctionProvider(new CustomFunctionProviderConfig(def.id!!, def.name)));
+
+    const client = await harness.getAppClient(appResponse);
+
+    const id = "123abc";
+    const user = await client.auth.loginWithCredential(new FunctionCredential({id}));
+
+    expect(user).toBeDefined();
+
+    expect(user.id).toBeDefined();
+    expect(user.identities[0].id).toBeDefined();
+    expect(id).toEqual(user.identities[0].id);
+    expect(FunctionAuthProvider.DEFAULT_NAME).toEqual(user.loggedInProviderName);
+    expect(FunctionAuthProvider.TYPE).toEqual(user.loggedInProviderType);
+    expect(UserType.Normal).toEqual(user.userType);
+    expect(FunctionAuthProvider.TYPE).toEqual(user.identities[0].providerType);
+    expect(client.auth.isLoggedIn).toBeTruthy();
+  });
+
+  it("should fail authentication using a custom function", async () => {
+    const { app: appResponse, appResource: app } = await harness.createApp();
+
+    const def = await app.functions.create(new StitchFunction(
+        "funkyAuth",
+        false,
+        `
+        exports = function(payload) {
+            return 0;
+        }`
+    ));
+
+    await harness.addProvider(app, new CustomFunctionProvider(new CustomFunctionProviderConfig(def.id!!, def.name)));
+
+    const client = await harness.getAppClient(appResponse);
+
+    const id = "123abc";
+    try {
+      await client.auth.loginWithCredential(new FunctionCredential({id}));
+      fail("loginWithCredential with FunctionCredential should have failed");
+    } catch (error) {
+      expect(error instanceof StitchServiceError).toBeTruthy();
+    }
+  });
+
   it("should call reset password function", async () => {
     const { app: appResponse, appResource: app } = await harness.createApp();
     
diff --git a/packages/server/coretest/__tests__/StitchAppClientIntTests.ts b/packages/server/coretest/__tests__/StitchAppClientIntTests.ts
