survey notification implementation

Author: francescospissu

Diff for: arduino-ide-extension/src/browser/arduino-ide-frontend-module.ts

@@ -121,6 +121,8 @@ import { SaveAsSketch } from './contributions/save-as-sketch';
 import { SaveSketch } from './contributions/save-sketch';
 import { VerifySketch } from './contributions/verify-sketch';
 import { UploadSketch } from './contributions/upload-sketch';
+import { SurveyNotification } from './contributions/survey-notification';
+import { SurveyRetriever } from './survey/survey-retriever';
 import { CommonFrontendContribution } from './theia/core/common-frontend-contribution';
 import { EditContributions } from './contributions/edit-contributions';
 import { OpenSketchExternal } from './contributions/open-sketch-external';
@@ -475,6 +477,12 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
   bind(EditorMode).toSelf().inSingletonScope();
   bind(FrontendApplicationContribution).toService(EditorMode);
 
+  // Survey notification
+  bind(SurveyRetriever).toSelf().inSingletonScope();
+
+  bind(SurveyNotification).toSelf().inSingletonScope();
+  bind(FrontendApplicationContribution).toService(SurveyNotification);
+
   // Layout and shell customizations.
   rebind(TheiaOutlineViewContribution)
     .to(OutlineViewContribution)

Diff for: arduino-ide-extension/src/browser/contributions/survey-notification.ts

@@ -0,0 +1,62 @@
+import { MessageService } from '@theia/core';
+import { FrontendApplicationContribution } from '@theia/core/lib/browser';
+import { inject, injectable } from '@theia/core/shared/inversify';
+import { shell } from '@theia/electron/shared/electron';
+import { LocalStorageService } from '@theia/core/lib/browser';
+import { SurveyRetriever } from '../survey/survey-retriever';
+import { nls } from '@theia/core/lib/common';
+
+const SURVEY_MESSAGE = nls.localize(
+  'arduino/survey/surveyMessage',
+  'Please help us improve by answering this super short survey. We value our community and would like to get to know our supporters a little better.'
+);
+const DO_NOT_SHOW_AGAIN = nls.localize(
+  'arduino/survey/dismissSurvey',
+  'DON’T SHOW ANYMORE'
+);
+const GO_TO_SURVEY = nls.localize(
+  'arduino/survey/answerSurvey',
+  'ANSWER SURVEY'
+);
+
+@injectable()
+export class SurveyNotification implements FrontendApplicationContribution {
+  @inject(MessageService)
+  protected readonly messageService: MessageService;
+
+  @inject(LocalStorageService)
+  protected readonly localStorageService: LocalStorageService;
+
+  @inject(SurveyRetriever)
+  protected readonly surveyRetriever: SurveyRetriever;
+
+  async onStart(): Promise<void> {
+    const survey = await this.surveyRetriever.getSurvey();
+    const surveyAnswered = await this.localStorageService.getData(
+      this.surveyKey(survey.id),
+      'notAnswered'
+    );
+
+    if (surveyAnswered !== 'notAnswered') {
+      return;
+    }
+
+    this.messageService
+      .info(SURVEY_MESSAGE, DO_NOT_SHOW_AGAIN, GO_TO_SURVEY)
+      .then(async (answer) => {
+        switch (answer) {
+          case GO_TO_SURVEY:
+            shell.openExternal(survey.url.href);
+            this.localStorageService.setData(this.surveyKey(survey.id), true);
+            break;
+          case DO_NOT_SHOW_AGAIN:
+            this.localStorageService.setData(this.surveyKey(survey.id), false);
+            break;
+        }
+      });
+  }
+
+  private surveyKey(id: string): string {
+    return `answered_survey:${id}`;
+  }
+}

Diff for: arduino-ide-extension/src/browser/survey/survey-retriever.ts

@@ -0,0 +1,20 @@
+import { injectable } from '@theia/core/shared/inversify';
+
+export type Survey = {
+  url: URL;
+  id: string;
+};
+
+const SURVEY_BASE_URL = 'https://surveys.hotjar.com/';
+const surveyId = '17887b40-e1f0-4bd6-b9f0-a37f229ccd8b';
+
+@injectable()
+export class SurveyRetriever {
+  public async getSurvey(): Promise<Survey> {
+    const survey: Survey = {
+      url: new URL(SURVEY_BASE_URL + surveyId),
+      id: surveyId,
+    };
+    return new Promise((resolve) => setTimeout(() => resolve(survey), 1000));
+  }
+}