✨ feat(members): add by email (#553)

* ✨ feat: add member by email

* ♻️ refactor: use union response for success and error

* chore: use member constructor in repository

codegen.config.ts

@@ -50,6 +50,8 @@ const config: CodegenConfig = {
  documentMode: "string",
  enumsAsTypes: true,
  useTypeImports: true,
+ // We must explicitly call include this as we don't do so automatically
+ skipTypename: true,
  },
  presetConfig: {
  useTypeImports: true,
@@ -78,6 +80,8 @@ const config: CodegenConfig = {
  config: {
  enumsAsTypes: true,
  useTypeImports: true,
+ // We must explicitly call include this as we don't do so automatically
+ skipTypename: true,
  },
  presetConfig: {
  /* Fragment masking is only useful for actual clients, and it's not relevant for testing */

infrastructure/modules/blob_storage/main.tf

@@ -7,7 +7,7 @@ resource "azurerm_storage_account" "main" {
  account_replication_type = var.account_replication_type
  blob_properties {
  cors_rule {
- allowed_headers = ["x-ms-blob-content-type","x-ms-blob-type","x-ms-client-request-id","x-ms-version"]
+ allowed_headers = ["*"]
  allowed_methods = ["GET", "DELETE", "PUT", "HEAD", "MERGE", "POST", "OPTIONS", "PUT", "PATCH"]
  allowed_origins = ["http://localhost:3000", "localhost:3000"]
  exposed_headers = ["x-ms-meta-*"]

schema.graphql

@@ -5,18 +5,33 @@ Please do not edit this file directly.
 To regenerate this file, run `npm run generate:gql`
 """
 
+enum AddMemberErrorCode {
+ ALREADY_MEMBER
+ USER_NOT_FOUND
+}
+
+type AddMemberErrorResponse {
+ code: AddMemberErrorCode!
+ message: String!
+}
+
 input AddMemberInput {
+ """The email of the user ot add to the organization"""
+ email: String
+
  """The ID of the organization to add the user to"""
  organizationId: ID!
 
  """The role of the user in the organization, defaults to Role.MEMBER"""
  role: Role
 
  """The ID of the user to add to the organization"""
- userId: ID!
+ userId: ID
 }
 
-type AddMemberResponse {
+union AddMemberResponse = AddMemberErrorResponse | AddMemberSuccessResponse
+
+type AddMemberSuccessResponse {
  member: Member!
 }
 

src/domain/errors.ts

@@ -198,17 +198,27 @@ const DomainErrorType = {
 
 type ErrorType = (typeof DomainErrorType)[keyof typeof DomainErrorType];
 
-class DomainError<TErrorType extends ErrorType> extends Error {
+class DomainError<
+ TErrorType extends ErrorType,
+ TName extends string,
+> extends Error {
  public code: ErrorCode;
  public type: TErrorType;
+ public name: TName;
 
  constructor(
  message: string,
- options: { code: ErrorCode; type: TErrorType; cause?: unknown },
+ options: {
+ code: ErrorCode;
+ type: TErrorType;
+ cause?: unknown;
+ name: TName;
+ },
  ) {
  super(message, { cause: options.cause });
  this.code = options.code;
  this.type = options.type;
+ this.name = options.name;
  Error.captureStackTrace(this);
  }
 
@@ -223,7 +233,8 @@ class DomainError<TErrorType extends ErrorType> extends Error {
 }
 
 class InvalidArgumentErrorV2 extends DomainError<
- typeof DomainErrorType.InvalidArgumentError
+ typeof DomainErrorType.InvalidArgumentError,
+ "InvalidArgumentError"
 > {
  public reason: Record<string, string[] | undefined> | undefined;
 
@@ -238,6 +249,7 @@ class InvalidArgumentErrorV2 extends DomainError<
  super(message, {
  code: errorCodes.ERR_BAD_USER_INPUT,
  type: DomainErrorType.InvalidArgumentError,
+ name: "InvalidArgumentError",
  ...rest,
  });
  this.reason = reason;

src/graphql/organizations/__tests__/unit/organizations.test.ts

@@ -184,15 +184,17 @@ describe("OrganizationResolvers", () => {
  mutation: graphql(`
  mutation addMember2 {
  addMember(data: { userId: "user", organizationId: "org" }) {
- member {
- id
- organization {
- id
- members {
- id
- }
- }
- }
+ ... on AddMemberSuccessResponse {
+ member {
+ id
+ organization {
+ id
+ members {
+ id
+ }
+ }
+ }
+ }
  }
  }
  `),
@@ -245,18 +247,20 @@ describe("OrganizationResolvers", () => {
  {
  mutation: graphql(`
  mutation addMember2 {
- addMember(data: { userId: "user", organizationId: "org" }) {
- member {
- id
- organization {
- id
- members {
- id
- }
+ addMember(data: { userId: "user", organizationId: "org" }) {
+ ... on AddMemberSuccessResponse {
+ member {
+ id
+ organization {
+ id
+ members {
+ id
+ }
+ }
+ }
  }
- }
- }
- }
+ }
+ }
  `),
  },
  {

src/graphql/organizations/resolvers/AddMemberErrorResponse.ts

@@ -0,0 +1,19 @@
+import type { AddMemberErrorResponseResolvers } from "./../../types.generated.js";
+export const AddMemberErrorResponse: AddMemberErrorResponseResolvers = {
+ code: ({ error }) => {
+ switch (error.name) {
+ case "InvalidArgumentError":
+ return "ALREADY_MEMBER";
+ case "NotFoundError":
+ return "USER_NOT_FOUND";
+ }
+ },
+ message: ({ error }) => {
+ switch (error.name) {
+ case "InvalidArgumentError":
+ return "User is already a member of the organization";
+ case "NotFoundError":
+ return "User not found";
+ }
+ },
+};

src/graphql/organizations/resolvers/AddMemberSuccessResponse.ts

@@ -0,0 +1,2 @@
+import type { AddMemberSuccessResponseResolvers } from "./../../types.generated.js";
+export const AddMemberSuccessResponse: AddMemberSuccessResponseResolvers = {};

src/graphql/organizations/resolvers/Mutation/addMember.ts

@@ -1,23 +1,53 @@
+import { ApolloServerErrorCode } from "@apollo/server/errors";
+import { GraphQLError } from "graphql";
 import { OrganizationRole } from "~/domain/organizations.js";
 import type { MutationResolvers } from "./../../../types.generated.js";
 export const addMember: NonNullable<MutationResolvers["addMember"]> = async (
  _parent,
  { data },
  ctx,
 ) => {
- const { userId: memberId, organizationId, role } = data;
- const addMemberResult = await ctx.organizations.members.addMember(ctx, {
- userId: memberId,
- organizationId,
- role: role ?? OrganizationRole.MEMBER,
- });
- if (!addMemberResult.ok) {
- switch (addMemberResult.error.name) {
- case "PermissionDeniedError":
- case "UnauthorizedError":
- throw addMemberResult.error;
+ const { userId, email, organizationId, role } = data;
+ let addMemberResult: Awaited<
+ ReturnType<typeof ctx.organizations.members.addMember>
+ >;
+ if (userId) {
+ addMemberResult = await ctx.organizations.members.addMember(ctx, {
+ userId,
+ organizationId,
+ role: role ?? OrganizationRole.MEMBER,
+ });
+ } else if (email) {
+ addMemberResult = await ctx.organizations.members.addMember(ctx, {
+ email,
+ organizationId,
+ role: role ?? OrganizationRole.MEMBER,
+ });
+ } else {
+ throw new GraphQLError("You must provide either a userId or an email.", {
+ extensions: {
+ code: ApolloServerErrorCode.BAD_USER_INPUT,
+ },
+ });
+ }
+
+ if (addMemberResult.ok) {
+ return {
+ __typename: "AddMemberSuccessResponse",
+ member: addMemberResult.data.member,
+ };
+ }
+
+ switch (addMemberResult.error.name) {
+ case "InvalidArgumentError":
+ case "NotFoundError": {
+ return {
+ __typename: "AddMemberErrorResponse",
+ error: addMemberResult.error,
+ };
+ }
+ default: {
+ throw addMemberResult.error;
  }
  }
- const { member } = addMemberResult.data;
- return { member };
 };