Add expand child for getFolder (#33)

Add expand child for getFolder

Author: Olha Virolainen

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.1 (July 31, 2020)
+
+* Fix retrieving mail folders issue
+
 # 1.0.0 (July 29, 2020)
 
 * Use this.logger functionality instead of console.log

README.md

@@ -53,7 +53,8 @@ Name|Mandatory|Description|Values|
 |`OAUTH_CLIENT_ID`| true | Microsoft Graph Application OAuth2 Client ID | Can be found in your application page on [https://portal.azure.com](https://portal.azure.com) |
 |`OAUTH_CLIENT_SECRET`| true | Microsoft Graph Application OAuth2 Client Secret | Can be found in your application page on [https://portal.azure.com](https://portal.azure.com) |
 |`LOG_LEVEL`| false | Controls logger level | `trace`, `debug`, `info`, `warn`, `error` |
-|`MAIL_RETRIEVE_MAX_COUNT`| false | Define max count mails could be retrieved per one `Poll for New Mail` trigger execution. Default to 1000| 1000 |
+|`MAIL_RETRIEVE_MAX_COUNT`| false | Define max count mails could be retrieved per one `Poll for New Mail` trigger execution. Defaults to 1000| 1000 |
+|`TOP_LIST_MAIL_FOLDER`| false | Define the maximum number of folders that can be found for dropdown fields containing a list of Mail Folder. Defaults to 100| 100 |
 
 ## Credentials
 To create new credentials you need to authorize in Microsoft system using OAuth2 protocol - details are described in [Requirements](#requirements) section.

component.json

@@ -71,7 +71,7 @@
               "label": "Start Time",
               "viewClass": "TextFieldView",
               "required": false,
-              "note": "Default: minimum time",
+              "note": "Default: minimum time 1970-01-01T00:00:00.000Z",
               "placeholder": "2020-07-20T11:44:53.999Z"
             },
             "pollOnlyUnreadMail": {

lib/Client.js

@@ -1,6 +1,7 @@
 const { OAuth2RestClient } = require('@elastic.io/component-commons-library');
 
 const MAIL_RETRIEVE_MAX_COUNT = process.env.MAIL_RETRIEVE_MAX_COUNT || 1000;
+const TOP_LIST_MAIL_FOLDER = process.env.TOP_LIST_MAIL_FOLDER || 100;
 
 class Client {
   constructor(emitter, cfg) {
@@ -22,7 +23,16 @@ class Client {
 
   async getMailFolders() {
     const response = await this.restClient.makeRequest({
-      url: '/me/mailFolders',
+      url: `/me/mailFolders?$top=${TOP_LIST_MAIL_FOLDER}`,
+      method: 'GET',
+    });
+
+    return response.value;
+  }
+
+  async listChildFolders(parentId) {
+    const response = await this.restClient.makeRequest({
+      url: `/me/mailFolders/${parentId}/childFolders?$top=${TOP_LIST_MAIL_FOLDER}`,
       method: 'GET',
     });
 

lib/utils/selectViewModels.js

@@ -1,15 +1,29 @@
+/* eslint-disable no-restricted-syntax,no-param-reassign,no-await-in-loop */
 const { Client } = require('../Client');
 
+async function getChildFolders(client, parentId, result) {
+  const childResults = await client.listChildFolders(parentId);
+  for (const childResult of childResults) {
+    result[childResult.id] = childResult.displayName;
+    if (childResult.childFolderCount > 0) {
+      await getChildFolders(client, childResult.id, result);
+    }
+  }
+}
+
 exports.getFolders = async function getFolders(cfg) {
   const client = new Client(this, cfg);
   this.logger.info('Getting list of folders...');
   const items = await client.getMailFolders();
   this.logger.trace('Found folders: %j', items);
   this.logger.info('Processing list of folders...');
   const result = {};
-  items.forEach((item) => {
+  for (const item of items) {
     result[item.id] = item.displayName;
-  });
+    if (item.childFolderCount > 0) {
+      await getChildFolders(client, item.id, result);
+    }
+  }
   this.logger.trace('Result: %j', result);
   return result;
 };

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "outlook-component",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "elastic.io integration component for Office 365 Outlook REST API",
   "homepage": "http://www.outlook.com/",
   "license": "Apache-2.0",

package.json

@@ -17,7 +17,7 @@ describe('Outlook Read Mail', () => {
   const refreshTokenUri = 'https://login.microsoftonline.com';
   const refreshTokenApi = '/common/oauth2/v2.0/token';
   const microsoftGraphUri = 'https://graph.microsoft.com/v1.0';
-  const microsoftGraphMailFolders = '/me/mailFolders';
+  const microsoftGraphMailFolders = '/me/mailFolders?$top=100';
 
   let self;
   let cfg;
@@ -48,4 +48,47 @@ describe('Outlook Read Mail', () => {
     expect(scope1.isDone()).to.eql(true);
     expect(scope2.isDone()).to.eql(true);
   });
+
+  it('getFolder test with child', async () => {
+    const parentFolder = {
+      id: 1,
+      displayName: 'Level 1',
+      childFolderCount: 1,
+    };
+    const childFolder = {
+      id: 2,
+      displayName: 'Level 2',
+      childFolderCount: 1,
+    };
+    const childChildFolder = {
+      id: 3,
+      displayName: 'Level 3',
+      childFolderCount: 0,
+    };
+    const scope1 = nock(refreshTokenUri).post(refreshTokenApi)
+      .reply(200, {
+        access_token: 1,
+        expires_in: 3600,
+      });
+
+    const scope2 = nock(microsoftGraphUri).get(microsoftGraphMailFolders)
+      .reply(200, { value: [parentFolder] });
+
+    const scope3 = nock(microsoftGraphUri).get(`/me/mailFolders/${parentFolder.id}/childFolders?$top=100`)
+      .reply(200, { value: [childFolder] });
+
+    const scope4 = nock(microsoftGraphUri).get(`/me/mailFolders/${childFolder.id}/childFolders?$top=100`)
+      .reply(200, { value: [childChildFolder] });
+
+    const result = await getFolders.call(self, cfg);
+    expect(result).to.eql({
+      1: 'Level 1',
+      2: 'Level 2',
+      3: 'Level 3',
+    });
+    expect(scope1.isDone()).to.eql(true);
+    expect(scope2.isDone()).to.eql(true);
+    expect(scope3.isDone()).to.eql(true);
+    expect(scope4.isDone()).to.eql(true);
+  });
 });