refactor: Move globals, import types, add return types

Author: ffflorian

electron/src/interfaces/global.ts electron/src/global.tselectron/src/interfaces/global.ts renamed to electron/src/global.ts

@@ -17,13 +17,12 @@
  *
  */
 
-import {DesktopCapturer} from 'electron';
+import type {DesktopCapturer} from 'electron';
 import type {WebAppEvents} from '@wireapp/webapp-events';
-import {Data as OpenGraphResult} from 'open-graph';
+import type {Data as OpenGraphResult} from 'open-graph';
 
-import * as EnvironmentUtil from '../runtime/EnvironmentUtil';
-import {i18nStrings} from './locale';
-import {Schemata} from './main';
+import type * as EnvironmentUtil from './runtime/EnvironmentUtil';
+import type {i18nStrings} from './locale/locale';
 
 declare global {
   interface Window {
@@ -57,7 +56,7 @@ declare global {
 
   namespace NodeJS {
     interface Global {
-      _ConfigurationPersistence: Schemata;
+      _ConfigurationPersistence: Record<string, any>;
       desktopCapturer: DesktopCapturer;
       environment: typeof EnvironmentUtil;
       openGraphAsync(url: string): Promise<OpenGraphResult>;

electron/src/interfaces/index.ts

@@ -35,30 +35,31 @@ interface DisplayCertificateErrorOptions {
 }
 
 enum CertificateVerificationResult {
-  SUCCESS = 0, // Indicates success and disables Certificate Transparency verification
+  /** Indicates success and disables Certificate Transparency verification */
+  SUCCESS = 0,
   FAILURE = -2,
   USE_CHROMIUM_VALIDATION = -3,
 }
 
+enum CHROMIUM_ERRORS {
+  CERT_AUTHORITY_INVALID = -202,
+  CERT_COMMON_NAME_INVALID = -200,
+}
+
+enum RESPONSE {
+  GO_BACK = 0,
+  RETRY = 0,
+  SAVE_CERTIFICATE = 1,
+  SHOW_DETAILS = 1,
+}
+
 class CertificateVerifyProcManager {
   private static bypassCertificatePinning = false;
   private static isDialogLocked = false;
   public static mainWindow: BrowserWindow;
 
   private static readonly dialogUnlockTimeout = 6000;
 
-  public static readonly CHROMIUM_ERRORS = {
-    CERT_AUTHORITY_INVALID: -202,
-    CERT_COMMON_NAME_INVALID: -200,
-  };
-
-  private static readonly RESPONSE = {
-    GO_BACK: 0,
-    RETRY: 0,
-    SAVE_CERTIFICATE: 1,
-    SHOW_DETAILS: 1,
-  };
-
   private static readonly LOCALE = {
     RETRY: getText('certificateVerifyProcManagerRetry'),
     SHOW_DETAILS: getText('certificateVerifyProcManagerShowDetails'),
@@ -78,7 +79,7 @@ class CertificateVerifyProcManager {
     certificate: Certificate,
     options: DisplayCertificateErrorOptions,
   ): Promise<void> {
-    const goBack = async () => {
+    const goBack = async (): Promise<void> => {
       // Go back to the dialog
       await this.displayCertificateError(hostname, certificate, {
         ...options,
@@ -101,13 +102,13 @@ class CertificateVerifyProcManager {
       // For Linux and Windows, use a message box with the ability to save the certificate
       const {response} = await dialog.showMessageBox(this.mainWindow, {
         buttons: [this.LOCALE.SHOW_DETAILS_GO_BACK, this.LOCALE.SHOW_DETAILS_SAVE_CERTIFICATE],
-        cancelId: this.RESPONSE.GO_BACK,
+        cancelId: RESPONSE.GO_BACK,
         detail: textDetails,
         message: this.LOCALE.SHOW_DETAILS_TITLE,
         type: 'info',
       });
       switch (response) {
-        case this.RESPONSE.SAVE_CERTIFICATE: {
+        case RESPONSE.SAVE_CERTIFICATE: {
           const {filePath: chosenPath} = await dialog.showSaveDialog(this.mainWindow, {
             defaultPath: `${hostname}.pem`,
           });
@@ -118,7 +119,7 @@ class CertificateVerifyProcManager {
           await this.displayCertificateDetails(hostname, certificate, options);
           break;
         }
-        case this.RESPONSE.GO_BACK: {
+        case RESPONSE.GO_BACK: {
           await goBack();
           break;
         }
@@ -152,16 +153,16 @@ class CertificateVerifyProcManager {
 
     const {checkboxChecked, response} = await dialog.showMessageBox(this.mainWindow, {
       buttons: [this.LOCALE.RETRY, this.LOCALE.SHOW_DETAILS],
-      cancelId: this.RESPONSE.RETRY,
+      cancelId: RESPONSE.RETRY,
       checkboxChecked: isChromiumError ? undefined : isCheckboxChecked,
       checkboxLabel: isChromiumError ? undefined : this.LOCALE.WARNING_BYPASS,
-      defaultId: this.RESPONSE.RETRY,
+      defaultId: RESPONSE.RETRY,
       detail: isChromiumError ? this.LOCALE.WARNING_TEXT_CHROMIUM : this.LOCALE.WARNING_TEXT_PINNING,
       message: this.LOCALE.WARNING_TITLE,
       type: 'warning',
     });
     switch (response) {
-      case this.RESPONSE.RETRY: {
+      case RESPONSE.RETRY: {
         if (!isChromiumError) {
           this.bypassCertificatePinning = checkboxChecked;
           if (this.bypassCertificatePinning) {
@@ -174,7 +175,7 @@ class CertificateVerifyProcManager {
         break;
       }
 
-      case this.RESPONSE.SHOW_DETAILS: {
+      case RESPONSE.SHOW_DETAILS: {
         await this.displayCertificateDetails(hostname, certificate, {
           bypassDialogLock,
           isCheckboxChecked: checkboxChecked,
@@ -186,14 +187,14 @@ class CertificateVerifyProcManager {
   }
 }
 
-export const attachTo = (main: BrowserWindow) => {
+export const attachTo = (main: BrowserWindow): void => {
   CertificateVerifyProcManager.mainWindow = main;
 };
 
 export const setCertificateVerifyProc = async (
   request: CertificateVerifyProcProcRequest,
   cb: (verificationResult: number) => void,
-) => {
+): Promise<void> => {
   const {hostname, validatedCertificate, verificationResult, errorCode} = request;
   // Check browser results
   if (verificationResult !== 'net::OK') {
@@ -202,8 +203,7 @@ export const setCertificateVerifyProc = async (
     );
 
     const isCommonCertificateError =
-      errorCode === CertificateVerifyProcManager.CHROMIUM_ERRORS.CERT_COMMON_NAME_INVALID ||
-      errorCode === CertificateVerifyProcManager.CHROMIUM_ERRORS.CERT_AUTHORITY_INVALID;
+      errorCode === CHROMIUM_ERRORS.CERT_COMMON_NAME_INVALID || errorCode === CHROMIUM_ERRORS.CERT_AUTHORITY_INVALID;
     if (isCommonCertificateError) {
       await CertificateVerifyProcManager.displayCertificateChromiumError(hostname, validatedCertificate);
     }

electron/src/interfaces/locale.ts

@@ -19,8 +19,8 @@
 
 import {DateUtil} from '@wireapp/commons';
 import {dialog, SaveDialogOptions} from 'electron';
-import * as fs from 'fs-extra';
 import imageType from 'image-type';
+import * as fs from 'fs-extra';
 import * as path from 'path';
 
 import {getLogger} from '../logging/getLogger';
@@ -40,7 +40,7 @@ export const downloadLogs = async (bytes: Uint8Array, timestamp: Date = new Date
   return downloadFile(bytes, filename, options);
 };
 
-export const downloadImage = async (bytes: Uint8Array, timestamp?: string) => {
+export const downloadImage = async (bytes: Uint8Array, timestamp?: string): Promise<void> => {
   const type = imageType(bytes);
   const options: SaveDialogOptions = {};
 
@@ -59,7 +59,7 @@ export const downloadImage = async (bytes: Uint8Array, timestamp?: string) => {
   return downloadFile(bytes, filename, options);
 };
 
-export const downloadFile = async (bytes: Uint8Array, filename: string, options?: SaveDialogOptions) => {
+export const downloadFile = async (bytes: Uint8Array, filename: string, options?: SaveDialogOptions): Promise<void> => {
   try {
     const {filePath: chosenPath} = await dialog.showSaveDialog({defaultPath: filename, ...options});
     if (chosenPath) {
@@ -70,7 +70,7 @@ export const downloadFile = async (bytes: Uint8Array, filename: string, options?
   }
 };
 
-export const suggestFileName = (timestamp?: string) => {
+export const suggestFileName = (timestamp?: string): string => {
   const imageDate = timestamp ? new Date(Number(timestamp)) : new Date();
   const {date: formattedDate, time: formattedTime} = DateUtil.isoFormat(imageDate);
   return `Wire ${formattedDate} at ${formattedTime}`.replace(/:/g, '-');

electron/src/interfaces/main.ts

@@ -22,8 +22,8 @@ import {parse as parseContentType, ParsedMediaType} from 'content-type';
 import {IncomingMessage} from 'http';
 import {decode as iconvDecode} from 'iconv-lite';
 import {Data as OpenGraphResult, parse as openGraphParse} from 'open-graph';
-import * as path from 'path';
 import {parse as parseUrl} from 'url';
+import * as path from 'path';
 
 import {getLogger} from '../logging/getLogger';
 import {config} from '../settings/config';