STITCH-4077 Javascript SDK: Decode and expose customData on UserProfile (#349)

jsflax · web-flow · commit 310f0bd5af80 · 2020-01-03T15:10:10.000Z
diff --git a/packages/browser/core/src/core/auth/StitchAuth.ts b/packages/browser/core/src/core/auth/StitchAuth.ts
@@ -207,4 +207,9 @@ export default interface StitchAuth {
    * @param listener 
    */
   removeAuthListener(listener: StitchAuthListener);
+
+  /**
+   * Refresh a user's custom data field.
+   */
+  refreshCustomData(): Promise<void>;
 }
diff --git a/packages/browser/core/src/core/auth/StitchUser.ts b/packages/browser/core/src/core/auth/StitchUser.ts
@@ -83,6 +83,17 @@ export default interface StitchUser extends CoreStitchUser {
    */
   readonly identities: StitchUserIdentity[];
 
+  /**
+   * You can store arbitrary data about your application users
+   * in a MongoDB collection and configure Stitch to automatically
+   * expose each user’s data in a field of their user object.
+   * For example, you might store a user’s preferred language,
+   * date of birth, or their local timezone.
+   *
+   * If this functionality has not been configured, it will be empty.
+   */
+  readonly customData: { [key: string]: any };
+
   /**
    * Links this {@link StitchUser} with a new identity, where the identity is 
    * resolved via an external OAuth2 login process (e.g. Facebook or Google). 
diff --git a/packages/browser/core/src/core/auth/internal/StitchAuthImpl.ts b/packages/browser/core/src/core/auth/internal/StitchAuthImpl.ts
@@ -407,6 +407,10 @@ export default class StitchAuthImpl extends CoreStitchAuth<StitchUser>
     }
   }
 
+  public refreshCustomData(): Promise<void> {
+    return this.refreshAccessToken();
+  }
+  
   /**
    * Utility function used to force the compiler to enforce an exhaustive 
    * switch statment in dispatchAuthEvent at compile-time.
diff --git a/packages/browser/core/src/core/auth/internal/StitchUserFactoryImpl.ts b/packages/browser/core/src/core/auth/internal/StitchUserFactoryImpl.ts
@@ -37,7 +37,8 @@ export default class StitchUserFactoryImpl
     loggedInProviderName: string,
     isLoggedIn: boolean,
     lastAuthActivity: Date,
-    userProfile: StitchUserProfileImpl
+    userProfile: StitchUserProfileImpl,
+    customData?: { [key: string]: any }
   ): StitchUser {
     return new StitchUserImpl(
       id,
@@ -46,7 +47,8 @@ export default class StitchUserFactoryImpl
       isLoggedIn,
       lastAuthActivity,
       userProfile,
-      this.auth
+      this.auth,
+      customData
     );
   }
 }
diff --git a/packages/browser/core/src/core/auth/internal/StitchUserImpl.ts b/packages/browser/core/src/core/auth/internal/StitchUserImpl.ts
@@ -33,15 +33,17 @@ export default class StitchUserImpl extends CoreStitchUserImpl
     isLoggedIn: boolean,
     lastAuthActivity: Date,
     profile: StitchUserProfileImpl,
-    private readonly auth: StitchAuthImpl
+    private readonly auth: StitchAuthImpl,
+    customData?: { [key: string] : any }
   ) {
     super(
       id, 
       loggedInProviderType, 
       loggedInProviderName, 
       isLoggedIn, 
       lastAuthActivity,
-      profile
+      profile,
+      customData
     );
   }
 
diff --git a/packages/browser/coretest/__tests__/StitchCustomUserDataIntTests.ts b/packages/browser/coretest/__tests__/StitchCustomUserDataIntTests.ts
@@ -0,0 +1,97 @@
+import { BaseStitchBrowserIntTestHarness } from "mongodb-stitch-browser-testutils";
+import { 
+	AnonProviderConfig, 
+	CustomUserConfigData, 
+	MongoConfig,
+	MongoDbRule,
+	MongoDbService,
+	Role,
+	Rule,
+	Schema,
+	ServiceResource,
+	StitchFunction,
+	UserpassProvider,
+	UserpassProviderConfig
+} from "mongodb-stitch-core-admin-client";
+import { UserPasswordCredential } from "mongodb-stitch-core-sdk";
+import { StitchAppClient } from "mongodb-stitch-browser-core";
+
+const harness = new BaseStitchBrowserIntTestHarness();
+
+beforeAll(() => harness.setup());
+afterAll(() => harness.teardown());
+
+describe("StitchAppClient", () => {
+	const db = "db1"
+	const coll = "coll1"
+	const functionName = "addUserProfile";
+	const user = "stitch@10gen.com";
+	const password = "stitchuser";
+	const colorField = "favoriteColor";
+	const favoriteColor = "blue";
+
+	let client: StitchAppClient;
+
+	it("should define custom data", async () => {
+		const { app: appResponse, appResource: app } = await harness.createApp();
+		await harness.addProvider(app, new AnonProviderConfig());
+		const mongoConfg = new MongoConfig("mongodb://localhost:26000");
+		const mongoService = new MongoDbService(mongoConfg);		
+		const svc = await harness.addService(app, mongoService);
+		
+		await harness.addRule(svc[1] as ServiceResource<Rule, MongoDbService>, new MongoDbRule(
+			db,
+			coll,
+			[new Role()],
+			new Schema()));
+
+		await harness.addProvider(app,
+			new UserpassProvider(new UserpassProviderConfig(
+			   "http://emailConfirmUrl.com",
+			   "http://resetPasswordUrl.com",
+			   "email subject",
+			   "password subject")));
+				
+		await app.customUserData.create(new CustomUserConfigData(
+			(svc[0] as MongoDbService).id,
+			db,
+			coll,
+			"recoome",
+			true));
+
+		await app.functions.create(new StitchFunction(
+			"addUserProfile",
+			false,
+			`
+			exports = async function(color) {
+				const coll = context.services.get("mongodb1")
+				.db("${db}").collection("${coll}");
+				await coll.insertOne({
+					"recoome": context.user.id,
+					"${colorField}": "${favoriteColor}"
+				});
+				return true;
+			}
+			`,
+			undefined));
+
+		client = harness.getAppClient(appResponse);
+		await harness.registerAndLoginWithUserPass(app, client, user, password);
+		expect(client.auth.user).toBeDefined();
+		expect(client.auth.user!!.customData).toEqual({});
+
+		await client.callFunction(functionName, [favoriteColor]);
+
+		await client.auth.refreshCustomData();
+
+		expect(client.auth.user!!.customData[colorField]).toEqual(favoriteColor);
+	});
+
+	it("should have custom data defined on login", async () => {
+		await client.auth.logout();
+
+		await client.auth.loginWithCredential(new UserPasswordCredential(user, password));
+
+		expect(client.auth.user!!.customData[colorField]).toEqual(favoriteColor);
+	})
+});
diff --git a/packages/core/admin-client/package.json b/packages/core/admin-client/package.json
@@ -63,7 +63,6 @@
     "build-main": "tsc -p tsconfig.cjs.json",
     "build-module": "tsc -p tsconfig.esm.json",
     "prepare": "npm run build",
-    "test": "jest",
     "watch": "tsc -w -p tsconfig.esm.json",
     "lint": "tslint 'src/**/*.ts' '__tests__/**/*.ts'",
     "lint-fix": "tslint --fix 'src/**/*.ts' '__tests__/**/*.ts'",
diff --git a/packages/core/admin-client/src/StitchAdminUser.ts b/packages/core/admin-client/src/StitchAdminUser.ts
@@ -64,6 +64,8 @@ class StitchAdminUser implements CoreStitchUser {
    */
   public readonly profile: StitchUserProfileImpl;
 
+  public readonly customData: { [key: string] : any };
+
   /**
    * An array of `StitchCore.StitchUserIdentity` objects representing the identities linked
    * to this user which can be used to log in as this user.
@@ -81,14 +83,16 @@ class StitchAdminUser implements CoreStitchUser {
     providerName: string,
     isLoggedIn: boolean,
     lastAuthActivity: Date,
-    userProfile: StitchUserProfileImpl
+    userProfile: StitchUserProfileImpl,
+    customData?: { [key: string] : any }
   ) {
     this.id = id;
     this.loggedInProviderType = providerType;
     this.loggedInProviderName = providerName;
     this.isLoggedIn = isLoggedIn;
     this.lastAuthActivity = lastAuthActivity;
     this.profile = userProfile;
+    this.customData = customData === undefined ? {} : customData;
   }
 }
 
@@ -103,15 +107,17 @@ class StitchAdminUserFactory implements StitchUserFactory<StitchAdminUser> {
     loggedInProviderName: string,
     isLoggedIn: boolean,
     lastAuthActivity: Date,
-    userProfile?: StitchUserProfileImpl
+    userProfile?: StitchUserProfileImpl,
+    customData?: { [key: string] : any }
   ): StitchAdminUser {
     return new StitchAdminUser(
       id,
       loggedInProviderType,
       loggedInProviderName,
       isLoggedIn,
       lastAuthActivity,
-      userProfile!
+      userProfile!,
+      customData
     );
   }
 }
diff --git a/packages/core/admin-client/src/apps/AppsResources.ts b/packages/core/admin-client/src/apps/AppsResources.ts
@@ -17,6 +17,7 @@
 import { EJSON } from "bson";
 import { Method, StitchAuthRequest } from "mongodb-stitch-core-sdk";
 import { AuthProvidersResource } from "../authProviders/AuthProvidersResources";
+import { CustomUserDataResource } from "../customUserData/CustomUserDataConfig";
 import { DebugResource } from "../debug/DebugResources";
 import { FunctionsResource } from "../functions/FunctionsResources";
 import { deserialize, jsonProperty } from "../JsonMapper";
@@ -55,6 +56,10 @@ export class AppResource extends BasicResource<App> {
     this.adminAuth,
     `${this.url}/auth_providers`
   );
+  public readonly customUserData = new CustomUserDataResource(
+    this.adminAuth,
+    `${this.url}/custom_user_data`
+  );
   public readonly debug = new DebugResource(
     this.adminAuth,
     `${this.url}/debug`
diff --git a/packages/core/admin-client/src/customUserData/CustomUserDataConfig.ts b/packages/core/admin-client/src/customUserData/CustomUserDataConfig.ts
@@ -0,0 +1,30 @@
+import { EJSON } from "bson";
+import { Method, StitchAuthRequest } from "mongodb-stitch-core-sdk";
+import { jsonProperty, serialize } from "../JsonMapper"
+import { BasicResource } from "../Resources"
+
+
+export class CustomUserConfigData {
+	constructor(
+		@jsonProperty("mongo_service_id") public mongoServiceId: string,
+		@jsonProperty("database_name") public databaseName: string,
+		@jsonProperty("collection_name") public collectionName: string,
+		@jsonProperty("user_id_field") public userIdField: string,
+		@jsonProperty("enabled") public enabled: boolean) {
+	}
+}
+
+export class CustomUserDataResource extends BasicResource<void> {
+	// POST a new application
+  // - parameter name: name of the new application
+  // - parameter defaults: whether or not to enable default values
+  public create(data: CustomUserConfigData): Promise<void> {
+    const req = new StitchAuthRequest.Builder()
+      .withMethod(Method.PATCH)
+      .withPath(this.url)
+      .withBody(EJSON.stringify(serialize(data)))
+      .build();
+
+    return this.adminAuth.doAuthenticatedRequest(req).then((_) => { return } );
+  }
+}
diff --git a/packages/core/admin-client/src/index.ts b/packages/core/admin-client/src/index.ts
@@ -29,6 +29,7 @@ import {
   UserpassProvider, 
   UserpassProviderConfig
 } from "./authProviders/ProviderConfigs";
+import { CustomUserConfigData } from "./customUserData/CustomUserDataConfig";
 import { FunctionResource, FunctionsResource, StitchFunction } from "./functions/FunctionsResources";
 import {
   AdditionalFields,
@@ -94,6 +95,7 @@ export {
   AwsSesRule,
   HttpRule,
   ConfirmationEmail,
+  CustomUserConfigData,
   HttpAction,
   MongoConfig,
   MongoDbService,
diff --git a/packages/core/sdk/src/auth/internal/CoreStitchAuth.ts b/packages/core/sdk/src/auth/internal/CoreStitchAuth.ts
@@ -18,7 +18,6 @@ import { EJSON } from "bson";
 import { Codec, Decoder } from "../../internal/common/Codec";
 import { wrapDecodingError } from "../../internal/common/StitchErrorUtils";
 import { Storage } from "../../internal/common/Storage";
-import ContentTypes from "../../internal/net/ContentTypes";
 import EventStream from "../../internal/net/EventStream";
 import Headers from "../../internal/net/Headers";
 import Method from "../../internal/net/Method";
@@ -36,6 +35,7 @@ import { StitchRequestErrorCode } from "../../StitchRequestErrorCode";
 import StitchServiceError from "../../StitchServiceError";
 import { StitchServiceErrorCode } from "../../StitchServiceErrorCode";
 import Stream from "../../Stream";
+import CoreStitchUserImpl from "../internal/CoreStitchUserImpl";
 import AnonymousAuthProvider from "../providers/anonymous/AnonymousAuthProvider";
 import StitchAuthResponseCredential from "../providers/internal/StitchAuthResponseCredential";
 import StitchCredential from "../StitchCredential";
@@ -291,6 +291,10 @@ export default abstract class CoreStitchAuth<TStitchUser extends CoreStitchUser>
       try {
         const partialInfo = ApiAuthInfo.fromJSON(JSON.parse(response.body!));
         this.activeUserAuthInfo = this.activeUserAuthInfo.merge(partialInfo);
+        if (partialInfo.accessToken && this.user instanceof CoreStitchUserImpl) {
+          const userData = JWT.fromEncoded(partialInfo.accessToken).userData;
+          (this.user as CoreStitchUserImpl).customData = userData === undefined ? {} : userData;
+        }
       } catch (err) {
         throw new StitchRequestError(
           err,
@@ -804,15 +808,17 @@ export default abstract class CoreStitchAuth<TStitchUser extends CoreStitchUser>
 
     // Provisionally set so we can make a profile request
     this.activeUserAuthInfo = newAuthInfo;
+
     this.currentUser = this.userFactory.makeUser(
       this.activeUserAuthInfo.userId!,
       credential.providerType,
       credential.providerName,
       this.activeUserAuthInfo.isLoggedIn,
       new Date(),
-      undefined
+      undefined,
+      JWT.fromEncoded(newAuthInfo.accessToken!!).userData
     );
-
+    
     return this.doGetUserProfile()
       .then(profile => {
 
@@ -876,7 +882,8 @@ export default abstract class CoreStitchAuth<TStitchUser extends CoreStitchUser>
           credential.providerName,
           this.activeUserAuthInfo.isLoggedIn,
           this.activeUserAuthInfo.lastAuthActivity!,
-          profile
+          profile,
+          JWT.fromEncoded(newAuthInfo.accessToken!!).userData
         );
 
         // Dispatch a UserAdded event if this is the first time this user is 
@@ -1039,7 +1046,7 @@ export default abstract class CoreStitchAuth<TStitchUser extends CoreStitchUser>
           loggedOutAuthInfo.loggedInProviderName!,
           loggedOutAuthInfo.isLoggedIn,
           loggedOutAuthInfo.lastAuthActivity!,
-          loggedOutAuthInfo.userProfile
+          loggedOutAuthInfo.userProfile,
         );
       }
       
diff --git a/packages/core/sdk/src/auth/internal/CoreStitchUser.ts b/packages/core/sdk/src/auth/internal/CoreStitchUser.ts
@@ -62,4 +62,15 @@ export default interface CoreStitchUser {
    * This includes login, logout, and active user changed.
    */
   readonly lastAuthActivity: Date;
+
+  /**
+   * You can store arbitrary data about your application users
+   * in a MongoDB collection and configure Stitch to automatically
+   * expose each user’s data in a field of their user object.
+   * For example, you might store a user’s preferred language,
+   * date of birth, or their local timezone.
+   *
+   * If this value has not been configured, it will be empty.
+   */
+  readonly customData: { [key: string]: any };
 }
diff --git a/packages/core/sdk/src/auth/internal/CoreStitchUserImpl.ts b/packages/core/sdk/src/auth/internal/CoreStitchUserImpl.ts
diff --git a/packages/core/sdk/src/auth/internal/JWT.ts b/packages/core/sdk/src/auth/internal/JWT.ts
diff --git a/packages/core/sdk/src/auth/internal/StitchUserFactory.ts b/packages/core/sdk/src/auth/internal/StitchUserFactory.ts
diff --git a/packages/react-native/core/src/core/auth/internal/StitchAuthImpl.ts b/packages/react-native/core/src/core/auth/internal/StitchAuthImpl.ts
diff --git a/packages/server/core/src/core/auth/internal/StitchAuthImpl.ts b/packages/server/core/src/core/auth/internal/StitchAuthImpl.ts

Original file line number	Diff line number	Diff line change
`@@ -407,6 +407,10 @@ export default class StitchAuthImpl extends CoreStitchAuth<StitchUser>`
`407`	`407`	`}`
`408`	`408`	`}`
`409`	`409`
	`410`	`+ public refreshCustomData(): Promise<void> {`
	`411`	`+ return this.refreshAccessToken();`
	`412`	`+ }`
	`413`	`+`
`410`	`414`	`/**`
`411`	`415`	`* Utility function used to force the compiler to enforce an exhaustive`
`412`	`416`	`* switch statment in dispatchAuthEvent at compile-time.`