Implements CRUD event operations. #13

MalteRei · 2020-05-01T18:03:51Z

Preparations

Please check if the PR fulfills these requirements

[X ] The commit message follows our guidelines
Tests for the changes have been added (for bug fixes / features)
[X ] Docs have been added / updated (for bug fixes / features)

🎫 Description

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
feature
What is the current behavior? (You can also link to an open issue here)
Current behavior is not applicable because the application did not exist before.
What is the new behavior (if this is a feature change)?
Add CRUD operations against Microsoft Graph for MCC events.
Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
No
Other information:

🔒 Closes

Which issue(s) is (are) being closed by the PR?
#3

source: https://www.gitignore.io/api/visualstudio

Creates a new project with an asp net core api application using https, no authentication and docker disabled

… for the api to use.

Source: https://www.gitignore.io/api/visualstudio

Someone with the right permissions needs to do a POST call to https://graph.microsoft.com/v1.0/schemaExtensions Also I think type Boolean is not allowed for targetType event schema extension. Which is why we might have to change requiredPhotoAgreement #1

Starting from scratch to use [resource owner password credential flow](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth-ropc) Additional resources of interest: 1. https://docs.microsoft.com/en-us/azure/azure-functions/functions-dotnet-dependency-injection 2. https://docs.microsoft.com/en-us/azure/active-directory/develop/scenario-desktop-acquire-token?tabs=dotnet#b2c-specifics 3. https://github.com/Azure-Samples/active-directory-dotnetcore-console-up-v2

…s public client in AAD under authentication

#3

#3 Still need to do testing and figure out how we want to restrict the api in the regard which parts of the graph events we want to expose.

I got Username/Password flow to work by removing all permissions the application had in Azure and adding them back.

Removes all the code where I tried to get the graph authentication working.

To be able to have the schema extension as a type inside the event the MCCEvent can be created from an Outlook Event.

Found solution to Problem where casting additional data to the EventSchemaExtension object from JObject did not work. However, JObject has a conversion method.

… expose to the event engine api.

Add documentation.

urmade · 2020-05-01T18:10:58Z

Could you please provide Build instructions to start the project locally or an URL to an endpoint where the code is deployed?

MalteRei · 2020-05-01T18:37:49Z

Could you please provide Build instructions to start the project locally or an URL to an endpoint where the code is deployed?

The code is not yet deployed because it needs to be secured first.
However, you can run it locally with the following steps:

Create MCC-App_Event-Engine\Microsoft.CampusCommunity.EventEngine\Microsoft.CampusCommunity.EventEngine.Api/local.settings.json file. This file is not checked in to GitHub because of sensitive information.
Inside local.settings.json add the following:
{ "IsEncrypted": false, "Values": { "AzureWebJobsStorage": "UseDevelopmentStorage=true", "FUNCTIONS_WORKER_RUNTIME": "dotnet", "Graph:TenantId": "[Insert tenant if here]", "Graph:ClientId": "b1e984e3-af89-43f2-bc75-13cdb5fa2948", "Graph:AdminPrincipalUsername": "[your mcc tenant username]", "Graph:AdminPrincipalPassword": "[your password]" } }
Install Azure Functions Core Tools for this project you will need version 3.x
In the command line navigate to MCC-App_Event-Engine\Microsoft.CampusCommunity.EventEngine\Microsoft.CampusCommunity.EventEngine.Api
Run func start --build

When running it if you get an error along the lines of Could not find a part of the path 'D:\home\data\byob_graphmap' see this GitHub issue. I usually get this error. For me the solution of adding a different path to the configuration file does not solve the problem. This comment does work for me.

Please let me know if there are any issues.

urmade · 2020-05-02T08:51:48Z

Please specify that .net core 3.1 is required to run the program (had errors when trying to run func build with .net core 2.2). I now get the following error:

Microsoft.CampusCommunity.EventEngine.Api: Method not found: 'Microsoft.Extensions.DependencyInjection.IServiceCollection Microsoft.Azure.Functions.Extensions.DependencyInjection.IFunctionsHostBuilder.get_Services()'.
Value cannot be null.

Steps to reproduce:

Clone repository.
Install tools as described (.net core 3.1.201 and azure-functions-core-tools through npm)
Run MCC-App_Event-Engine\Microsoft.CampusCommunity.EventEngine\Microsoft.CampusCommunity.EventEngine.Api>func start --build

Host Machine:
Windows 10 Version 10.0.18362 Build 18362
dotnet SDK: 3.1.201
.NET Core runtimes installed:
Microsoft.AspNetCore.All 2.1.14 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.All]
Microsoft.AspNetCore.App 2.1.14 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 3.1.0 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 3.1.3 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.NETCore.App 2.1.14 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 3.1.0 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 3.1.3 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.WindowsDesktop.App 3.1.0 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
Microsoft.WindowsDesktop.App 3.1.3 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]

Any hints on how to proceed?

MalteRei · 2020-05-02T13:38:16Z

I have no idea.
Maybe it is easier if you try it in Visual Studio.
The local.settings.json configuration stays the same.
Instead of steps 3. + 4. and 5. check that you have required Visual Studio tools installed. Open the solution file from MCC-App_Event-Engine\Microsoft.CampusCommunity.EventEngine in Visual Studio. Once all projects are loaded press F5 to run Azure Function locally.

urmade · 2020-05-09T07:38:35Z

Sorry for the long delay. These steps have worked for me:

De-Install the npm packages azure-functions-core-tools (only necessary because I tried to install them manually before)
Create new folder tmp in C:\Users{User}\
Execute subst d: C:\Users\turba\tmp
Go to Visual Studio, open project, start Microsoft.CampusCommunity.EventEngine.Api

To the actual functionality:
Where can I find documentation for the endpoints? It would be specifically interesting:

what kinds of Events the GET Events API returns (right now it is an empty Array),
what information is needed to POST a request and
what side-effects creating a new event has (in which calendar it is located, does it send any emails to everyone, ...)?

Please add this to the documentation.

MalteRei · 2020-05-10T16:38:22Z

I am glad it finally worked. Sorry for the inconvenience.

what kinds of Events the GET Events API returns (right now it is an empty Array)
If the GET Events API returns an empty array then it is most likely because there are no future events and by default past events are not returned. To show past events include a boolean parameter like so http://localhost:7071/api/v1/events?includePastEvents=true.
what information is needed to POST a request
Right now the event you can POST to the endpoint is similar to the MS Graph event.
The main difference is that the event engine also accepts custom data. Namely readableId: String, planningStatus: String, titleImageUrl: String, requirePhotoAgreement: Boolean and supportRequestId: String.
However, we can work together to think about what information the event engine should abstract because it is not needed.
Example POST request body:

    "subject": "EventEngine test event",
    "body": {
        "contentType": "HTML",
        "content": "Nothing to see. 👀"
    },
    "start": {
        "dateTime": "2019-06-16T12:00:00",
        "timeZone": "Pacific Standard Time"
    },
    "end": {
        "dateTime": "2019-06-16T14:00:00",
        "timeZone": "Pacific Standard Time"
    },
    "location": {
        "displayName": "online"
    },
    "attendees": [
        {
            "emailAddress": {
                "address": "[email protected]",
                "name": "Malte Reimann"
            },
            "type": "required"
        }
    ],
    
        "readableId": "humanReadableId",
        "planningStatus": "completed",
        "titleImageUrl": "https://tctechcrunch2011.files.wordpress.com/2015/10/6f9a9902.jpg",
        "requirePhotoAgreement": false,
        "supportRequestId": "long-term field to handle event support requests automatically later on"
    
}

what side-effects creating a new event has (in which calendar it is located, does it send any emails to everyone, ...)?
There are no side-effects. Emails are only send to the people listed in the attendees property. In addition the events can be deleted by sending a DELETE request with the event id. Events are located in the events group calendar (group id: 7a77d007-2cd2-4cb5-bb71-5ff85aa92e82).

urmade · 2020-05-11T19:12:12Z

Please provide a documentation on this before you merge it back into master. A good inspiration for this is https://commasto-api-dev.azurewebsites.net/swagger/index.html, but you can also write a markdown page explaining URLs, allowed query parameters, necessary body input and possible responses from the API.
Although this API isn't yet production ready, we should always keep it in a state where other developers could work and test with it locally.

MalteRei · 2020-05-11T19:35:52Z

Please provide a documentation on this before you merge it back into master. A good inspiration for this is https://commasto-api-dev.azurewebsites.net/swagger/index.html, but you can also write a markdown page explaining URLs, allowed query parameters, necessary body input and possible responses from the API.
Although this API isn't yet production ready, we should always keep it in a state where other developers could work and test with it locally.

#14 is on the TODO list

MalteRei added 28 commits March 24, 2020 10:01

Add gitignore

7d821fe

source: https://www.gitignore.io/api/visualstudio

Init asp net core project

beb920a

Creates a new project with an asp net core api application using https, no authentication and docker disabled

Add project to structure interfaces on top of the underlying services…

b25e656

… for the api to use.

Create graph client configuration

1679ad0

Create .gitignore

b4f2a0f

Source: https://www.gitignore.io/api/visualstudio

Create Azure Functions Project

6c21b76

Create Azure Function accessing MS graph

da164c8

Change required photo agreement to String

12e8dfb

Add authentication provider to use graph sdk instead of http request

d43f748

Merge branch 'microsoft-graph-sdk' into CRUD-event-operations

d42ad1b

Merge branch 'azure-functions-graph-sdk' into CRUD-event-operations

6c78e04

Finishing up configuration for graph service. Need to turn on treat a…

447c1dc

…s public client in AAD under authentication

Adding Service to get all events.

cfaa508

#3

Implement get single and create event api routes

ca3fd6e

#3 Still need to do testing and figure out how we want to restrict the api in the regard which parts of the graph events we want to expose.

Add graph event service dependency injection

920ded6

Authentication against the graph works

44865b1

I got Username/Password flow to work by removing all permissions the application had in Azure and adding them back.

Refactoring code

ce5da30

Removes all the code where I tried to get the graph authentication working.

Change MCCEvent

2c58629

To be able to have the schema extension as a type inside the event the MCCEvent can be created from an Outlook Event.

Trying to get post event to work

84a7ea0

Create, delete and get works

fcbc379

Found solution to Problem where casting additional data to the EventSchemaExtension object from JObject did not work. However, JObject has a conversion method.

Change serialization of MCCEvent depending if we talk to graph api or…

773be0e

… expose to the event engine api.

Add patch enpoint

32aa2d3

Documenting MCCEvent class

acf7040

Add documentation to EventService

c0b640a

Update IEventSchemaExtension.cs

858915f

Add documentation.

Add documentation for GraphConfiguration

6bab4b4

MalteRei self-assigned this May 1, 2020

MalteRei added the documentation Improvements or additions to documentation label May 1, 2020

MalteRei added the feature request New feature or request label May 1, 2020

MalteRei added this to the Version 1.0 milestone May 1, 2020

MalteRei linked an issue May 1, 2020 that may be closed by this pull request

Implement get and create event features #3

Open

MalteRei requested a review from urmade May 1, 2020 18:05

Update .gitignore

f716aa2

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Implements CRUD event operations. #13

Implements CRUD event operations. #13

Uh oh!

MalteRei commented May 1, 2020

Uh oh!

urmade commented May 1, 2020

Uh oh!

MalteRei commented May 1, 2020 •

edited

Loading

Uh oh!

urmade commented May 2, 2020

Uh oh!

MalteRei commented May 2, 2020

Uh oh!

urmade commented May 9, 2020

Uh oh!

MalteRei commented May 10, 2020 •

edited

Loading

Uh oh!

urmade commented May 11, 2020

Uh oh!

MalteRei commented May 11, 2020

Uh oh!

Uh oh!

Implements CRUD event operations. #13

Are you sure you want to change the base?

Implements CRUD event operations. #13

Uh oh!

Conversation

MalteRei commented May 1, 2020

Preparations

🎫 Description

🔒 Closes

Uh oh!

urmade commented May 1, 2020

Uh oh!

MalteRei commented May 1, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

urmade commented May 2, 2020

Uh oh!

MalteRei commented May 2, 2020

Uh oh!

urmade commented May 9, 2020

Uh oh!

MalteRei commented May 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

urmade commented May 11, 2020

Uh oh!

MalteRei commented May 11, 2020

Uh oh!

Uh oh!

MalteRei commented May 1, 2020 •

edited

Loading

MalteRei commented May 10, 2020 •

edited

Loading