refactor(infrastructure): move infrastructure code to its own package

.github/workflows/test_infrastructure.yml

@@ -0,0 +1,35 @@
+name: Build and Test / Infrastructure
+
+concurrency:
+  group: '${{ github.head_ref || github.ref }} Infrastructure'
+  cancel-in-progress: true
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+  push:
+    branches:
+      - master
+
+jobs:
+  test:
+    name: Infrastructure Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/[email protected]
+
+      - name: Install Node
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: .nvmrc
+          cache: npm
+          cache-dependency-path: ./infrastructure/package.json
+
+      - name: Install NPM Dependencies
+        run: npm ci
+
+      - name: Infrastructure Test
+        run: npm run action infrastructure/test

client/package.json

@@ -45,6 +45,7 @@
     "cordova-plugin-statusbar": "^2.2.3",
     "electron-updater": "^5.0.5",
     "lit": "^2.2.2",
+    "@outline/infrastructure": "file:../infrastructure",
     "ShadowsocksConfig": "github:Jigsaw-Code/outline-shadowsocksconfig#v0.2.1",
     "socks": "^1.1.10",
     "sudo-prompt": "^9.2.1",
@@ -95,7 +96,6 @@
     "html-webpack-plugin": "^5.1.0",
     "husky": "^1.3.1",
     "i18n-strings-files": "^2.0.0",
-    "intl-messageformat": "^9.12.0",
     "istanbul": "^0.4.5",
     "karma": "^6.4.2",
     "karma-chrome-launcher": "^3.1.0",

client/src/www/app/app.ts

@@ -15,7 +15,7 @@
 import * as errors from '../model/errors';
 import * as events from '../model/events';
 import {Server} from '../model/server';
-import {OperationTimedOut} from '../../../infrastructure/timeout_promise';
+import {OperationTimedOut} from '@outline/infrastructure/timeout_promise';
 import {ServerListItem, ServerConnectionState} from '../views/servers_view';
 import {SERVER_CONNECTION_INDICATOR_DURATION_MS} from '../views/servers_view/server_connection_indicator';
 
@@ -27,7 +27,7 @@ import {Settings, SettingsKey} from './settings';
 import {Updater} from './updater';
 import {UrlInterceptor} from './url_interceptor';
 import {VpnInstaller} from './vpn_installer';
-import {Localizer} from '../../../infrastructure/i18n';
+import {Localizer} from '@outline/infrastructure/i18n';
 
 enum OUTLINE_ACCESS_KEY_SCHEME {
   STATIC = 'ss',

client/src/www/app/main.ts

@@ -23,7 +23,7 @@ import {makeConfig, SIP002_URI} from 'ShadowsocksConfig';
 import {OutlinePlatform} from './platform';
 import {Settings} from './settings';
 import {TunnelFactory} from './tunnel';
-import {Localizer} from '../../../infrastructure/i18n.js';
+import {Localizer} from '@outline/infrastructure/i18n';
 
 // Used to determine whether to use Polymer functionality on app initialization failure.
 let webComponentsAreReady = false;

client/src/www/app/outline_server_repository/outline_server_repository.spec.ts

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import {InMemoryStorage} from '../../../../infrastructure/memory_storage';
+import {InMemoryStorage} from '@outline/infrastructure/memory_storage';
 import {ServerIncompatible, ServerUrlInvalid, ShadowsocksUnsupportedCipher} from '../../model/errors';
 import {EventQueue, ServerAdded, ServerForgetUndone, ServerForgotten, ServerRenamed} from '../../model/events';
 

client/src/www/app/settings.spec.ts

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import {InMemoryStorage} from '../../../infrastructure/memory_storage';
+import {InMemoryStorage} from '@outline/infrastructure/memory_storage';
 
 import {Settings, SettingsKey} from './settings';
 

client/src/www/model/errors.ts

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 import {Server} from './server';
-import {CustomError} from '../../../infrastructure/custom_error';
+import {CustomError} from '@outline/infrastructure/custom_error';
 
 export class ServerAlreadyAdded extends CustomError {
   constructor(public readonly server: Server) {

client/src/www/testing/localize.ts

@@ -14,7 +14,7 @@
   limitations under the License.
 */
 
-import type {FormattableMessage, Localizer} from '../../../infrastructure/i18n';
+import type {FormattableMessage, Localizer} from '@outline/infrastructure/i18n';
 import englishMessages from '../messages/en.json';
 import IntlMessageFormat from 'intl-messageformat';
 

client/src/www/views/contact_view/index.ts

@@ -30,7 +30,7 @@ import {IssueType, UNSUPPORTED_ISSUE_TYPE_HELPPAGES} from './issue_type';
 import {AppType} from './app_type';
 import {FormValues, SupportForm, ValidFormValues} from './support_form';
 import {OutlineErrorReporter} from '../../shared/error_reporter';
-import {Localizer} from '../../../../infrastructure/i18n';
+import {Localizer} from '@outline/infrastructure/i18n';
 
 /** The possible steps in the stepper. Only one step is shown at a time. */
 enum Step {

client/src/www/views/contact_view/support_form/index.ts

@@ -25,7 +25,7 @@ import '@material/mwc-textfield';
 import {AppType} from '../app_type';
 import {TextField} from '@material/mwc-textfield';
 import {SelectedDetail} from '@material/mwc-menu/mwc-menu-base';
-import {Localizer} from '../../../../../infrastructure/i18n';
+import {Localizer} from '@outline/infrastructure/i18n';
 
 type FormControl = HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement;
 

client/src/www/views/servers_view/index.ts

@@ -24,7 +24,7 @@ import './server_list';
 
 import {ServerListItem as _ServerListItem} from './server_list_item';
 import {ServerConnectionState as _ServerConnectionState} from './server_connection_indicator';
-import { Localizer } from '../../../../infrastructure/i18n';
+import { Localizer } from '@outline/infrastructure/i18n';
 
 export type ServerListItem = _ServerListItem;
 

client/src/www/views/servers_view/server_list/index.ts

@@ -16,7 +16,7 @@ import {customElement, property} from 'lit/decorators.js';
 
 import '../server_list_item/server_card';
 import {ServerListItem} from '../server_list_item';
-import {Localizer} from '../../../../../infrastructure/i18n';
+import {Localizer} from '@outline/infrastructure/i18n';
 
 @customElement('server-list')
 export class ServerList extends LitElement {

client/src/www/views/servers_view/server_list_item/index.ts

@@ -14,7 +14,7 @@
 import {Ref} from 'lit/directives/ref';
 import {Menu} from '@material/mwc-menu';
 import {ServerConnectionState} from '../server_connection_indicator';
-import {Localizer} from '../../../../../infrastructure/i18n';
+import {Localizer} from '@outline/infrastructure/i18n';
 
 export enum ServerListItemEvent {
   CONNECT = 'ConnectPressed',

client/src/www/views/servers_view/server_list_item/server_card/index.ts

@@ -24,7 +24,7 @@ import {Menu} from '@material/mwc-menu';
 
 import {ServerListItem, ServerListItemElement, ServerListItemEvent} from '..';
 import {ServerConnectionState} from '../../server_connection_indicator';
-import {Localizer} from '../../../../../../infrastructure/i18n';
+import {Localizer} from '@outline/infrastructure/i18n';
 
 const sharedCSS = css`
   /* TODO(daniellacosse): reset via postcss */

commitlint.config.js

@@ -16,6 +16,7 @@ module.exports = {
         'client/electron/windows',
         'devtools',
         'docs',
+        'infrastructure',
         'manager',
         'manager/linux',
         'manager/mac',

server_manager/infrastructure/crypto.ts → infrastructure/crypto.ts

@@ -15,7 +15,7 @@
 import * as forge from 'node-forge';
 
 // Keys are in OpenSSH format
-export class KeyPair {
+export interface KeyPair {
   public: string;
   private: string;
 }

server_manager/infrastructure/i18n.spec.ts → infrastructure/i18n.spec.ts

@@ -19,25 +19,25 @@ describe('LanguageMatcher', () => {
     const SUPPORTED_LANGUAGES = i18n.languageList(['es', 'pt-BR', 'ru']);
     const matcher = new i18n.LanguageMatcher(SUPPORTED_LANGUAGES, undefined);
     const supportedLanguage = matcher.getBestSupportedLanguage(i18n.languageList(['pt-PT']));
-    expect(supportedLanguage.string()).toEqual('pt-BR');
+    expect(supportedLanguage?.string()).toEqual('pt-BR');
   });
   it('returns the right variant', () => {
     const SUPPORTED_LANGUAGES = i18n.languageList(['en-GB', 'en-IN', 'en-US']);
     const matcher = new i18n.LanguageMatcher(SUPPORTED_LANGUAGES, undefined);
     const supportedLanguage = matcher.getBestSupportedLanguage(i18n.languageList(['en-IN']));
-    expect(supportedLanguage.string()).toEqual('en-IN');
+    expect(supportedLanguage?.string()).toEqual('en-IN');
   });
   it('prefers first matched user language', () => {
     const SUPPORTED_LANGUAGES = i18n.languageList(['en-US', 'pt-BR']);
     const matcher = new i18n.LanguageMatcher(SUPPORTED_LANGUAGES, undefined);
     const supportedLanguage = matcher.getBestSupportedLanguage(i18n.languageList(['cn', 'en-GB', 'pt-BR']));
-    expect(supportedLanguage.string()).toEqual('en-US');
+    expect(supportedLanguage?.string()).toEqual('en-US');
   });
   it('returns default on no match', () => {
     const SUPPORTED_LANGUAGES = i18n.languageList(['es', 'pt-BR', 'ru']);
     const matcher = new i18n.LanguageMatcher(SUPPORTED_LANGUAGES, new i18n.LanguageCode('fr'));
     const supportedLanguage = matcher.getBestSupportedLanguage(i18n.languageList(['cn']));
-    expect(supportedLanguage.string()).toEqual('fr');
+    expect(supportedLanguage?.string()).toEqual('fr');
   });
   it('returns undefined on no match and no default', () => {
     const SUPPORTED_LANGUAGES = i18n.languageList(['es', 'pt-BR', 'ru']);

server_manager/infrastructure/i18n.ts → infrastructure/i18n.ts

@@ -12,6 +12,19 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+import {PrimitiveType, FormatXMLElementFn} from 'intl-messageformat';
+
+export type FormattableMessage =
+  | string
+  | symbol
+  | object
+  | PrimitiveType
+  | FormatXMLElementFn<symbol | object, string | symbol | object | (string | symbol | object)[]>;
+
+export interface Localizer {
+  (messageID: string, ...formatKeyValueList: FormattableMessage[]): string;
+}
+
 export class LanguageCode {
   private language: string;
   private normalizedLanguage: string;
@@ -32,7 +45,7 @@ export class LanguageCode {
 }
 
 export class LanguageMatcher {
-  constructor(private supportedLanguages: LanguageCode[], private defaultLanguage: LanguageCode = undefined) {}
+  constructor(private supportedLanguages: LanguageCode[], private defaultLanguage?: LanguageCode) {}
 
   // Goes over each user language, trying to find the supported language that matches
   // the best. We'll trim variants of the user and supported languages in order to find

server_manager/infrastructure/memory_storage.ts → infrastructure/memory_storage.ts

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 export class InMemoryStorage implements Storage {
-  readonly length: number;
+  readonly length = 0;
   [key: string]: {};
   [index: number]: string;
 

infrastructure/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@outline/infrastructure",
+  "version": "0.0.0",
+  "private": true,
+  "description": "Shared infrastructure code.",
+  "scripts": {
+    "clean": "rm -rf node_modules"
+  },
+  "devDependencies": {
+    "@types/jasmine": "^5.1.4",
+    "@types/node-forge": "^1.3.11",
+    "https-browserify": "^1.0.0",
+    "intl-messageformat": "^10.5.11",
+    "jasmine": "^5.1.0",
+    "stream-http": "^3.2.0",
+    "typescript": "^5.4.5"
+  },
+  "dependencies": {
+    "node-forge": "^1.3.1"
+  }
+}

server_manager/infrastructure/path_api.spec.ts → infrastructure/path_api.spec.ts

@@ -12,16 +12,16 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import {PathApiClient} from './path_api';
+import {type HttpRequest, type HttpResponse, PathApiClient} from './path_api';
 
 describe('PathApi', () => {
   // Mock fetcher
-  let lastRequest: HttpRequest;
-  let nextResponse: Promise<HttpResponse>;
+  let lastRequest: HttpRequest | undefined;
+  let nextResponse: Promise<HttpResponse> | undefined;
 
-  const fetcher = (request: HttpRequest) => {
+  const fetcher = (request: HttpRequest): Promise<HttpResponse> => {
     lastRequest = request;
-    return nextResponse;
+    return nextResponse!;
   };
 
   beforeEach(() => {

server_manager/infrastructure/path_api.ts → infrastructure/path_api.ts

@@ -119,13 +119,14 @@ export class PathApiClient {
     try {
       response = await this.fetcher(request);
     } catch (e) {
-      throw new ServerApiError(`API request to ${path} failed due to network error: ${e.message}`);
+      const msg = e instanceof Error ? e.message : 'unknown';
+      throw new ServerApiError(`API request to ${path} failed due to network error: ${msg}`);
     }
     if (response.status < 200 || response.status >= 300) {
       throw new ServerApiError(`API request to ${path} failed with status ${response.status}`, response);
     }
     if (!response.body) {
-      return;
+      return undefined as T;
     }
     // Assume JSON and unsafe cast to `T`.
     return JSON.parse(response.body);

infrastructure/test.action.sh

@@ -0,0 +1,26 @@
+#!/bin/bash -eu
+#
+# Copyright 2024 The Outline Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -e
+
+readonly TEST_DIR="${BUILD_DIR}/js/infrastructure/"
+rm -rf "${TEST_DIR}"
+
+# Use commonjs modules, jasmine runs in node.
+tsc -p "${ROOT_DIR}/infrastructure" --outDir "${TEST_DIR}" --module commonjs
+jasmine "output/build/js/**/*.spec.js"
+
+rm -rf "${TEST_DIR}"