Create editFlyer mutation

[vinnie4k]

Overview

This PR implements a mutation to edit a flyer.

Changes Made

editFlyer Mutation

• Created a mutation that returns the updated Flyer if successful given the following arguments:
  • {string} id the ID of the Flyer to edit
  • {string} categorySlug the slug for this flyer's category
  • {string} endDate the end date for this flyer's event in UTC ISO8601 format
  • {string} flyerURL the URL for this flyer when tapped
  • {string} imageB64 the base64 string representing the flyer's image
  • {string} location the location for this flyer's event
  • {string} startDate the start date for this flyer's event in UTC ISO8601 format
  • {string} title the title for this flyer
  • The imageB64 is uploaded to our Digital Ocean via a POST request.
• If the value of imageB64 is not null, then we know that the flyer image wants to be changed. In this case, the middleware for uploading Flyer images (FlyerUploadErrorInterceptor) had to be changed to account for the fact that this could be null. This could cause the createFlyer mutation to fail so I went back and tested it to see if it would still work.
• The difference between this mutation and thee createFlyer mutation is that most input are nullable, meaning that you can choose which fields to change. This required me to only make changes to the flyer fields if that field is not null to prevent it from being assigned a null value.
• Note that the flyer ID and organization do not change.

Test Coverage

• First, I had to make sure that createFlyer still works properly since I made changes to the middleware. It seems to work just fine so using this newly created Flyer. I also tested to see if deleteFlyer works as well just for insurance, and it is also fine.

{
  "title": "old_title",
  "startDate": "2023-09-05T17:00:00Z",
  "organizationID": "644ea608f910705ca19ab5f9",
  "location": "old_location",
  "imageB64": "iVBORw0KGgoAAAANSUhEUgAAAMAAAADACAYAAABS3GwHAAAACXBIWXMAACE4AAAhOAFFljFgAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAA8zSURBVHgB7Z1fUhvHFsbPGSGSvLGDO6wgUHUBkZcrwKnKW/AKglcAXoFhBbZXYHkFcd5SdWPQfQlYpAqyAk9WcLmpVCWFounbPSNhAfrTM9Mzmu7+flXEBimxA/31OXPO16eZDHLVboX9gNoc8JexoJCFWCMSK0S8QgBkRtzItXNDTBEzX4tY/Npcpu76jxcRGYKpIL32xhoHjW8F0YH8NCQAyieSm+y7pSXxuqgYcgvg8kmrLQS9IEFtAmBRMHWZ6WTjp4su5SCzAM6/aYWNPr3Bwgd1QjC/W26K51kjQpDlzZe7rReNW/qIxQ/qhnze3O/LtanWaKZ/T+dN2PWBVcgH5mZTPNWJBnMFkCz+WzojPOACu4hkxWhnnghmCqD39cYaDYIzlDGBncgSaoN3Nv/98/XUd0x7Id35xRUWP7Abvmkui/VpkWCiAJD2lI1q8ARv5a9jOxOvyZ/GvyhpHgLDTE2Hlia9u9Hn7+UPJyRgGHETU3DSOr14Ne0dSX8llgUHbD4mCfv95Hu68/CFRxFAlZFkV/eYgGmiZix3oa5enfrDXqvDgr4jYAy5rk+2Ti+Ox792TwDD1OcjAdNkWvwjenutM5SezSJTodXxVOheIyy4FS8JlMFJ1sWvGAzoWfq8AEwxTIXuuBOAyj2ZeJ+AaaLN04sO5WBbikYQvyZgDhlR1VoffXongMTYBsrghAqwHH/+ClHALONrPRGAyv2Ra5YAUzfv7j9ivdu9QRQwjFzrva+/SsrNiQAat3xEwDjNJIcvzrByEREwhhjESbo/TIHEtwRM08nz4DuDQqkUuI8sfyYlZkbpsxxk2XPVsABQFjWM+hkFcvG3CZjG9O6foE4+ETCGOr8eJB4UYBBxI3eWUhZqcuxPPlgTMAPzWkAsviRgDFWxKWP3H4EoYI44pjCQP7GQgCmi5Zg6VCIqCsg69lsChQnk5h+kc3uAIU7K3P1HxAJmRTPwSoADL8aIija9dEktEkiFiiNWMk2FADOpdEHCImEGCMAMRnd/NWJy3ntgkTADBGAADsxYHkbI+rSWMRFRoDgQQHE6ecfyzeCeZXcaKgowBXgWKAAEUJCyml7Dc8Fz2Tg9V+eLIwK5gACK0Smx7Ble7G5ruXRNp2A+AQEUoKzdf4T84by42m/PLVPDIpEfCCA/nfKbXmLl9ve/9KIALBK5gADyEZW9+49g4kNEgfKAAHIgu7Bvq7A8DP+0lf4ff2qVRREFsgMBZCd6OFypdGI+uvpmfnMMRrnsQADZWcgu+3CezTRSoxyaY7pAANmozPD2CKHXHMMsoWxAANlYaI6tO7sJFgl9IABdmK8XtvuPkFHgl73tudP7YJTTBwLQJeBadFtjoTe/FVFADwhAj86sa3YqJvyw2zqe9yYY5fSAADSoqumli3ZzDEa5uUAA8+lU1/TSJYNFAka5mUAAc6jb7j8iiQKazTFYJKYDAcxAVDTlIR9iRTbHYJEoCAQwndJn/BRG0IFOcwxRYDoQwHRqvPt/Qvtik8HgOYFHQACTiRbe9NJF0yKx2b28hlHuMRDAZKzKmXWjAIxyj4EAHmPP7j9CXfmz2zqY9zYY5R4DATzG1oqJ1vlhWCTuAwGMY+BSuwUS6jTHYJS7DwQwhqlL7RaFrkUijQKwSCgggE/U0PKQFT2LhIoChOnSCRDAkLpaHrKia5FIUj3mujhcFwYEkOLA7j8ii0VCeN8cgwAqnPFTGbBIaOO9AKqd8VMdus0x341yvgsgGlZE3EPTIuF7FPBdACfDioiTCMFa54cHlpd/i+CzAOyzPGRFiDVti4SnRjmfBeBJ7ssvtZpj4vMjHy0SvgrA/d3/Dv3mmI8WCS8F4NtB8WwWCb+igI8CKONSu5qjN2LdxyjgnQCca3rpojli3TejnG8CcMjykB2dEeu+GeW8EoC3u/8I3fPDiVHOj+aYPwJgfu3z7j8CFon7+CKAqDkQbloesgKLxD28EICrhre86N5C70MU8EEA1V9qV3+0bqH3IQr4IAAc/ZuA7i30rhvlXBeAR5aHrOhZJLaT1NHd5pjrAsDuPwNdi0Qz/uzYVYuEuwKwe8ZPRcAi4awAbJ/xUxmZLBLuRQFXBeC15SEruhYJF6OAkwLw3vKQFc3mmItGORcFgN0/BzoWCReNcs4JwJHd/0SQeEdVonkLvWtGOacEUO9L7fRRi2zr9MPTQUyrXOH4Qt1b6F2ySLgkgPpfapcR1YTaeH++Ln+rKloRlY/WLfQuWSRcEoATu/8kVERoxp+viwryb93mmCtRwBUBOG95UA+gytSn0qJyZ/joWSRUFKj8OaUEXBGAN2VPlRZtnV0cUIlpke6I9Thm66dLuyAALw1v6v9ZfqyWkxbpjVh3wShnvQACtn8XKkJpaZHmiHXbjXJWC0Awv/vn+3Pr89CijNIiuRk8JYNpkW5zzGaLhNUCWB7ghpNx1Gag0iKZw6vvS0RFyWSRsDMK2CwAZy0PqiOr8xA6jY3T81cyLdoxkRbpRgGmwMpChLUCcNnwFpM47N/Smc5o82mM0iL1fEBFooHmLfRKdGShUc5WAfhgeAvlxxu5+D4WiQZKCCotomJlU63zwzYWJGwUgHuX2s0mlNHgY2+v9aaIEFTZVKVFOcuWWrfQJwUJyywS1gnA2xk/sixpIi3aPD0/Skx2xJmqZ65aJGwTgO8zfkIapkW9r79ao5wkJrvTc1UyzZAW6VskbIoCtgkAJ71SQhrEVybSoizdZF2LhE1RwCYBYMbPQ5K0iK8ud1taA2+nod9NllGgP//mycQoZ8mlezYJALv/RMSK3MGPk7TIQNmU5qRFLMS+TnMsFnRsQ3PMFgFg959PSOr5wGxaFE16j05zLLl61QKLhBUC8O1Su0Kk1aKPhtKiyd1khywSNgjAw0vtimM0LYoDdSwzuvff17iF3gajXO0FgBk/hQjlx5sPe9vfF0qLuj9fP+omC7GmM2K97lGg7gLAjB8DqAfXpJv8ZOuliW7yKC3SGbFed6NcrQWA3d8wMR+ZNNnJen+k1RyrsVGutgJwZcZPDQnJkMlOjWxpaM4tqmsho64CcG7GTw0xYrLTPZFXV4tELQUQE640rQwDJjtd6miRqKMAolaaMwJtZJVFpSL5xyiGZMBkN486RoE6CgAPvhmQ0fJ5M/5idVPm4+ojOQFWRAgGTHazqFsUqJsAYHnIxjMVLYdjyxPUw2lz8NkOFRmqa8hkN4m6GeXqJgDs/rrMuAMtqb1z0YkZZkx2k6iTUa5OAsDunwG5i/5n1usG7SMhGTDZjVMno1ydBNAlUF8MmexG1MUiUR8BxIGzlzG7hKm0KH1uCRb+LFAXAUTKcEWgOuQzROr5T1KRiLIRkgGTHQeLH6++RPWgS6AixA0H/PTBM8KRuhmGiTKlN0OT3X7vydar5pJsXv6YrXmp/g693S0ZCXjutImyqEUEEBz/QKAi+PmkB+R02kbOB9MCJjvmoEsLpBYC4MFSRKAKZlba0lHnuQkph8kujsX/aIHUQgDI/6shFvzrrNeHDbWIipHNZMeLtUnXQQARgUpYYvFfqgpZNr29pQOqOYsXAEMAYHE4d1M8AFmoSxkUWIHq3A6H6rJ86BXUJsuBAIAWgunt8uCLo3Hn6Xm7FTYCOqO0AmQlSIGADtHW+4uD8cWvUKa29M4B3BIJHEY2KqdaqxNnp2BrG5kQAJjL8iCY2acRLKzt40AAoDABMVIgAGwEAgBeAwEAr4EAgNdAAMBrIADgNRAA8BoIAHgNBAC8BgIAXgMBAK+BAIDXQADAayAA4DUQAPAaCMBSmGfP07xqtxc2b9MmIABbEeLbWS/3g7/2CcwFArCXcNplFefpSELj93u5CMaiWExyWcVeK2Smt2ri81W7Ff4d0HfiVhwtcuS4TUAAtiPoQMiP3m6L+ndfZAJ6IAUCXgMBAK+BADwiptmzPIcPzyF5BATgF+Eve9tTy6ONvn+VIwjAM2KRXGN08PDrSUlV1P9CC9OgCuQdQpVH3/T2tg9lM2040lDsy5Kql2VTCMBXhFiT/1xLP/G3bIoUCHgNBAC8BgIAc+lTMPP5QOCGGOAyIohnOkvlE8R3ZCkQAJiLXOAvLp+02pNeGzpSQ7IUVIGAFiKms95eq6Ocp0t/UzRo8FpM4lBYflMkBAD0GTpP+ypvkL9xAaRAwGsgAOA1gc13vAJQDL4JyOIb/gAohrhZYuZrIURIwDNk5Jc/+/S3SRkzJN9gipbkw/xvBPyBqStLmScbP33ojn/5vN0KA6Zj+Zq1Ta3s8K+yDGrvLd8gM8823190Jr2w3b2I5C8HsuHVEbH43oupEkJcB4OYugR84Nnm6eTFP44ar0JxvONDcaQp134wVH5EwFlky+pEZ/GP2OxeXjMFJ+Q20bpc+0kfQH6D3hJwlWg5pg5lZOP0/BW5vDEy/6B+SQTAcfCOgKt019Mon5mYxGtylOZAKIGnAtjs/nytqgMEnIOD/NH9s/iLDrkIf9oU7qwQqjRGwDmSh9qcrHe76kE4IscYX+t3Aki+UYgCrhFRUdgtAQjmd+Obwj0z3GBAzwi4AxcvZYrYrUbp8kA8H//8ngBUSVSVzAi4gSjezJLPEP8gR1Br+2FB4JEdeuv04hipkCsYEIArHWHm62RtP2DieYBhKhQRsByxMu0srw5qWK5IB2jZTiTLnk8nvTBRACoVGsTkRTvcdeI4/5ndxq3d531TxE1TruVpvZCpJ8ISi4QnnhCXkSnM4dV+7hsjLZ8WLdeuXMOzGoEzj0QqT8gg5nVCOmQxYqX/x5+ZF3Jvb+uQ7D4jEDXl2lVreNab5p4JvkuHRocngH3EfDTrXoCHJBdlCDomW5FFnFlpzzhah+KVCDbfn6+jRGov6l6Ai93to3nvUw/NMvc/s/U8QOJ8fX+xo+t/yjQVQpWRZDRYlXklzHMlUk7zSawEJF729lpvrtKrkO6hnhMud7dfqgFYZGPqk+76q5NKnbPIPBhreH7gqdophCB1q0ibgFGCBnXkQiznaKIabHWbXKsa3dkcBIX93/8KyUbujnjm8zzlnguk/kAValREkH8LZZuNCBhBfW8rSDfDZPNKN7CQ7CJ1LDSCdbUGixj+Co9GHEYElVseqYPVjUB9Q3mNWHyZThtQV/Lg1vKsqFCe7tJ8SG40o3KgSvB8I0ioE2q/qfPr6hhj3vMNk/g/+AdLwFowy78AAAAASUVORK5CYII=",
  "flyerURL": "old_flyer_url",
  "endDate": "2023-09-05T17:00:00Z",
  "categorySlug": "old_category_slug"
}

I then tested the editFlyer mutation with this:

mutation EditFlyer($id: String!, $title: String, $startDate: String, $location: String, $imageB64: String, $flyerURL: String, $endDate: String, $categorySlug: String) {
  editFlyer(id: $id, title: $title, startDate: $startDate, location: $location, imageB64: $imageB64, flyerURL: $flyerURL, endDate: $endDate, categorySlug: $categorySlug) {
    ...flyerFields
  }
}

• If the input id does not represent any Flyer, an error is thrown with the message: “Cannot return null for non-nullable field Mutation.editFlyer.”
• If you provide a valid id but do not provide any other inputs, an error is NOT thrown and you get the same flyer back.
• I then went through every single field to make sure everything works properly.
  • endDate and startDate must in the proper format and will throw an error as intended if not.
  • If you are changing the flyer image, the old image URL will no longer be valid because it is deleted and is replaced with a new one as intended.
• See the first screenshot below for a successful request.
• It would be very tedious to write 20 difference test cases since I tested very throughly with the Playground and my local MongoDB, but I wrote a couple just to make sure that the mutation works in case anyone makes any changes. See second screenshot below.

Next Steps

• Work on implementing getAllFlyerCateogries.
• I believe that all functions should have proper documentation and the test suite description should also be refactored. Perhaps this could be something to do in the future.

Screenshots

[Archit404Error]

Good to go, just a few minor comments below. I like the detail you put into the PR description and how you explained your testing procedure in detail -- keep it up!

[Archit404Error]

Good to go