In-app survey extension (#1945)

* Initial in-app survey implementation

Signed-off-by: Lauri Nevala <lauri.nevala@gmail.com>

* Add surveyId fetching and store integration

Signed-off-by: Lauri Nevala <lauri.nevala@gmail.com>

* Add empty line

Signed-off-by: Lauri Nevala <lauri.nevala@gmail.com>

* Fix typos

Signed-off-by: Lauri Nevala <lauri.nevala@gmail.com>

* Use async version of machineId + refactoring

Signed-off-by: Lauri Nevala <lauri.nevala@gmail.com>

* Update preferences hint text

Signed-off-by: Lauri Nevala <lauri.nevala@gmail.com>

Co-authored-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

extensions/survey/src/refiner-js.d.ts

@@ -0,0 +1,3 @@
+declare module "refiner-js" {
+  export default function Refiner(key: string, value: string|object|number|Boolean|Array): void;
+}

extensions/survey/src/survey-preference.tsx

@@ -0,0 +1,27 @@
+import { Component } from "@k8slens/extensions";
+import React from "react";
+import { observer } from "mobx-react";
+import { SurveyPreferencesStore } from "./survey-preferences-store";
+
+@observer
+export class SurveyPreferenceInput extends React.Component<{survey: SurveyPreferencesStore}, {}> {
+  render() {
+    const { survey } = this.props;
+
+    return (
+      <Component.Checkbox
+        label="Allow in-app surveys"
+        value={survey.enabled}
+        onChange={v => survey.enabled = v }
+      />
+    );
+  }
+}
+
+export class SurveyPreferenceHint extends React.Component {
+  render() {
+    return (
+      <span>This will allow you to participate in surveys to improve the Lens experience.</span>
+    );
+  }
+}

extensions/survey/src/survey-preferences-store.ts

@@ -0,0 +1,36 @@
+import { Store } from "@k8slens/extensions";
+import { observable, toJS, when } from "mobx";
+
+export type SurveyPreferencesModel = {
+  enabled: boolean;
+};
+
+export class SurveyPreferencesStore extends Store.ExtensionStore<SurveyPreferencesModel> {
+
+  @observable enabled = true;
+
+  whenEnabled = when(() => this.enabled);
+
+  private constructor() {
+    super({
+      configName: "preferences-store",
+      defaults: {
+        enabled: true
+      }
+    });
+  }
+
+  protected fromStore({ enabled }: SurveyPreferencesModel): void {
+    this.enabled = enabled;
+  }
+
+  toJSON(): SurveyPreferencesModel {
+    return toJS({
+      enabled: this.enabled
+    }, {
+      recurseEverything: true
+    });
+  }
+}
+
+export const surveyPreferencesStore = SurveyPreferencesStore.getInstance<SurveyPreferencesStore>();

extensions/survey/src/survey.ts

@@ -0,0 +1,46 @@
+import { Util } from "@k8slens/extensions";
+import { machineId } from "node-machine-id";
+import Refiner from "refiner-js";
+import got from "got";
+import { surveyPreferencesStore } from "./survey-preferences-store";
+
+type SurveyIdResponse = {
+  surveyId: string;
+};
+export class Survey extends Util.Singleton {
+  static readonly PROJECT_ID = "af468d00-4f8f-11eb-b01d-23b6562fef43";
+  protected anonymousId: string;
+
+  private constructor() {
+    super();
+  }
+
+  async start() {
+    await surveyPreferencesStore.whenEnabled;
+
+    const surveyId = await this.fetchSurveyId();
+
+    if (surveyId) {
+      Refiner("setProject", Survey.PROJECT_ID);
+      Refiner("identifyUser", {
+        id: surveyId,
+      });
+
+    }
+  }
+
+  async fetchSurveyId() {
+    try {
+      const surveyApi = process.env.SURVEY_API_URL || "https://survey.k8slens.dev";
+      const anonymousId = await machineId();
+      const { body } = await got(`${surveyApi}/api/survey-id?anonymousId=${anonymousId}`, { responseType: "json"});
+
+      return (body as SurveyIdResponse).surveyId;
+    } catch(error) {
+      return null;
+    }
+
+  }
+}
+
+export const survey = Survey.getInstance<Survey>();