Added get_marketing_consent

Author: 0xdeafcafe

README.md

@@ -224,6 +224,28 @@ Creates a new user and subscription trial. The magic link sent to the user is tr
 	- `fingerprint`: The physical hardware id.
 
 
+### `get_marketing_consent`
+
+Returns the selected marketing consent level for a user. An error with the code `awaiting_consent` will be returned if the user hasn't set a consent level yet.
+
+#### Request
+
+```json
+{
+	"user_id": "user_000000C2kdCzNlbL1BqR5FeMatItU"
+}
+```
+
+#### Response
+
+```json
+{
+	"level": "general"
+}
+```
+
+- `level`: The consent level selected. Either `general` or `none`.
+
 ## Webhooks
 
 Webhooks URL's comprise of two parts; the webhook indicator, followed by the provider value. Each provider has an example below.

src/app/get-marketing-consent.ts

@@ -0,0 +1,23 @@
+import { Context, GetMarketingConsentRequest, GetMarketingConsentResponse } from '../types';
+import Squawk from '../utils/squawk';
+
+export default async function getMarketingConsent(
+	ctx: Context,
+	request: GetMarketingConsentRequest,
+): Promise<GetMarketingConsentResponse> {
+	const user = await ctx.app.dbClient.users.findUser(request.userId);
+
+	try {
+		const consent = await ctx.app.dbClient.marketingConsent.findUserMarketingConsent(user.id);
+
+		return { level: consent.level };
+	} catch (error) {
+		if (!(error instanceof Squawk))
+			throw error;
+
+		if (error.code === 'not_found')
+			throw new Squawk('awaiting_consent');
+
+		throw error;
+	}
+}

src/db/index.ts

@@ -3,6 +3,7 @@ import { Db, MongoClient } from 'mongodb';
 import AccessTokens from './access-tokens';
 import Authorizations from './authorizations';
 import Identifiers from './identifiers';
+import MarketingConsents from './marketing-consent';
 import ProviderMappings from './provider-mappings';
 import RefreshTokens from './refresh-tokens';
 import Subscriptions from './subscriptions';
@@ -16,6 +17,7 @@ export default class DbClient {
 	accessTokens!: AccessTokens;
 	authorizations!: Authorizations;
 	identifiers!: Identifiers;
+	marketingConsent!: MarketingConsents;
 	providerMappings!: ProviderMappings;
 	refreshTokens!: RefreshTokens;
 	subscriptions!: Subscriptions;
@@ -34,6 +36,7 @@ export default class DbClient {
 		this.authorizations = new Authorizations(this.db);
 		this.accessTokens = new AccessTokens(this.db);
 		this.identifiers = new Identifiers(this.db);
+		this.marketingConsent = new MarketingConsents(this.db);
 		this.providerMappings = new ProviderMappings(this.db);
 		this.refreshTokens = new RefreshTokens(this.db);
 		this.subscriptions = new Subscriptions(this.db);
@@ -47,6 +50,7 @@ export default class DbClient {
 		await this.authorizations.setupIndexes();
 		await this.accessTokens.setupIndexes();
 		await this.identifiers.setupIndexes();
+		await this.marketingConsent.setupIndexes();
 		await this.providerMappings.setupIndexes();
 		await this.refreshTokens.setupIndexes();
 		await this.subscriptions.setupIndexes();

src/db/marketing-consent.ts

@@ -0,0 +1,52 @@
+import ksuid from '@cuvva/ksuid';
+import { Db } from 'mongodb';
+
+import Squawk from '../utils/squawk';
+import Collection from './nest-collection';
+
+export type ConsentLevel = 'none' | 'general';
+
+export interface MarketingConsent {
+	id: string;
+	userId: string;
+	level: ConsentLevel;
+	createdAt: string;
+	updatedAt: string | null;
+}
+
+export default class MarketingConsents extends Collection<MarketingConsent> {
+	constructor(db: Db) {
+		super(db, 'marketing-consents');
+	}
+
+	async setupIndexes() {
+		await this.collection.createIndex({ userId: 1 }, { unique: true });
+	}
+
+	async upsertMarketingConsent(userId: string, level: ConsentLevel) {
+		const id = ksuid.generate('mktngconsent').toString();
+		const now = new Date().toISOString();
+
+		await this.collection.updateOne({ userId }, {
+			$set: {
+				level,
+				updatedAt: now,
+			},
+			$setOnInsert: {
+				_id: id,
+				userId,
+				createdAt: now,
+				removedAt: null,
+			},
+		}, { upsert: true });
+	}
+
+	async findUserMarketingConsent(userId: string) {
+		const identifier = await this.collection.findOne({ userId });
+
+		if (!identifier)
+			throw new Squawk('not_found');
+
+		return this.convertFromMongoDocument(identifier);
+	}
+}

src/interface/rpc/get-marketing-consent.json

@@ -0,0 +1,15 @@
+{
+	"type": "object",
+	"additionalProperties": false,
+
+	"required": [
+		"user_id"
+	],
+
+	"properties": {
+		"user_id": {
+			"type": "string",
+			"minLength": 1
+		}
+	}
+}

src/interface/rpc/get-marketing-consent.ts

@@ -0,0 +1,16 @@
+import getMarketingConsentImpl from '../../app/get-marketing-consent';
+import { Context, GetMarketingConsentRequest } from '../../types';
+import Squawk from '../../utils/squawk';
+import getMarketingConsentSchema from './get-marketing-consent.json';
+
+export default async function getMarketingConsent(ctx: Context, request: GetMarketingConsentRequest) {
+	if (!ctx.auth)
+		throw new Squawk('access_denied');
+
+	if (ctx.auth.type !== 'internal' && ctx.auth.userId !== request.userId)
+		throw new Squawk('access_denied');
+
+	return await getMarketingConsentImpl(ctx, request);
+}
+
+export { getMarketingConsentSchema };

src/interface/rpc/index.ts

@@ -1,5 +1,5 @@
 import { APIGatewayProxyEventV2 } from 'aws-lambda';
-import camelCaseKeys from 'camelcase-keys';
+import * as camelCaseKeys from 'camelcase-keys';
 import { validate } from 'jsonschema';
 import { Logger } from 'tslog';
 
@@ -8,6 +8,7 @@ import Squawk from '../../utils/squawk';
 import authenticateUser, { authenticateUserSchema } from './authenticate-user';
 import createTrialAndMagicLink, { createTrialAndMagicLinkSchema } from './create-trial-and-magic-link';
 import enrolAlphaUser, { enrolAlphaUserSchema } from './enrol-alpha-user';
+import getMarketingConsent, { getMarketingConsentSchema } from './get-marketing-consent';
 import getSubscriptionStatus, { getSubscriptionStatusSchema } from './get-subscription-status';
 import getSubscriptionStatus20201214, { getSubscriptionStatusSchema20201214 } from './get-subscription-status-2020-12-14';
 import getUser, { getUserSchema } from './get-user';
@@ -27,6 +28,10 @@ const v20201214: VersionSet = {
 		impl: authenticateUser,
 		schema: authenticateUserSchema,
 	},
+	get_marketing_consent: {
+		impl: getMarketingConsent,
+		schema: getMarketingConsentSchema,
+	},
 	get_subscription_status: {
 		impl: getSubscriptionStatus20201214,
 		schema: getSubscriptionStatusSchema20201214,

src/types.ts

@@ -1,5 +1,6 @@
 import { SESClient } from '@aws-sdk/client-ses';
-import { CancelType } from 'db/subscriptions';
+import { ConsentLevel } from './db/marketing-consent';
+import { CancelType } from './db/subscriptions';
 import { Stripe } from 'stripe';
 import { Logger } from 'tslog';
 
@@ -147,6 +148,19 @@ export interface GetUserResponse {
 	}[];
 }
 
+export interface GetMarketingConsentRequest {
+	userId: string;
+}
+
+export interface GetMarketingConsentResponse {
+	level: ConsentLevel;
+}
+
+export interface SetMarketingConsentRequest {
+	userId: string;
+	level: ConsentLevel;
+}
+
 export interface EnrolAlphaUserRequest {
 	email: string;
 }