rename frontend to web and update contributing guide (#2509)

* rename frontend to web and update contributing guide

* rename this time

* fix build

* restructure rust code

* update documentation

* update descriptions

* Update CONTRIBUTING.md

Co-authored-by: J H <2364004+Blu-J@users.noreply.github.com>

---------

Co-authored-by: Aiden McClelland <me@drbonez.dev>
Co-authored-by: Aiden McClelland <3732071+dr-bonez@users.noreply.github.com>
Co-authored-by: J H <2364004+Blu-J@users.noreply.github.com>

web/projects/ui/src/app/services/patch-db/data-model.ts

@@ -0,0 +1,376 @@
+import { ConfigSpec } from 'src/app/pkg-config/config-types'
+import { Url } from '@start9labs/shared'
+import { MarketplaceManifest } from '@start9labs/marketplace'
+import { BasicInfo } from 'src/app/pages/developer-routes/developer-menu/form-info'
+
+export interface DataModel {
+  'server-info': ServerInfo
+  'package-data': { [id: string]: PackageDataEntry }
+  ui: UIData
+}
+
+export interface UIData {
+  name: string | null
+  'ack-welcome': string // eOS emver
+  marketplace: UIMarketplaceData
+  dev: DevData
+  gaming: {
+    snake: {
+      'high-score': number
+    }
+  }
+  'ack-instructions': Record<string, boolean>
+  theme: string
+  widgets: readonly Widget[]
+}
+
+export interface Widget {
+  id: string
+  meta: {
+    name: string
+    width: number
+    height: number
+    mobileWidth: number
+    mobileHeight: number
+  }
+  url?: string
+  settings?: string
+}
+
+export interface UIMarketplaceData {
+  'selected-url': string
+  'known-hosts': {
+    'https://registry.start9.com/': UIStore
+    'https://community-registry.start9.com/': UIStore
+    [url: string]: UIStore
+  }
+}
+
+export interface UIStore {
+  name?: string
+}
+
+export interface DevData {
+  [id: string]: DevProjectData
+}
+
+export interface DevProjectData {
+  name: string
+  instructions: string
+  config: string
+  'basic-info'?: BasicInfo
+}
+
+export interface ServerInfo {
+  id: string
+  version: string
+  'last-backup': string | null
+  'lan-address': Url
+  'tor-address': Url
+  'ip-info': IpInfo
+  'last-wifi-region': string | null
+  'unread-notification-count': number
+  'status-info': ServerStatusInfo
+  'eos-version-compat': string
+  'password-hash': string
+  hostname: string
+  pubkey: string
+  'ca-fingerprint': string
+  'ntp-synced': boolean
+  zram: boolean
+  platform: string
+}
+
+export interface IpInfo {
+  [iface: string]: {
+    ipv4: string | null
+    ipv6: string | null
+  }
+}
+
+export interface ServerStatusInfo {
+  'backup-progress': null | {
+    [packageId: string]: {
+      complete: boolean
+    }
+  }
+  updated: boolean
+  'update-progress': { size: number | null; downloaded: number } | null
+  restarting: boolean
+  'shutting-down': boolean
+}
+
+export enum ServerStatus {
+  Running = 'running',
+  Updated = 'updated',
+  BackingUp = 'backing-up',
+}
+
+export interface PackageDataEntry {
+  state: PackageState
+  'static-files': {
+    license: Url
+    instructions: Url
+    icon: Url
+  }
+  manifest: Manifest
+  installed?: InstalledPackageDataEntry // exists when: installed, updating
+  'install-progress'?: InstallProgress // exists when: installing, updating
+}
+
+export enum PackageState {
+  Installing = 'installing',
+  Installed = 'installed',
+  Updating = 'updating',
+  Removing = 'removing',
+  Restoring = 'restoring',
+}
+
+export interface InstalledPackageDataEntry {
+  status: Status
+  manifest: Manifest
+  'last-backup': string | null
+  'system-pointers': any[]
+  'current-dependents': { [id: string]: CurrentDependencyInfo }
+  'current-dependencies': { [id: string]: CurrentDependencyInfo }
+  'dependency-info': {
+    [id: string]: {
+      title: string
+      icon: Url
+    }
+  }
+  'interface-addresses': {
+    [id: string]: { 'tor-address': string; 'lan-address': string }
+  }
+  'marketplace-url': string | null
+  'developer-key': string
+}
+
+export interface CurrentDependencyInfo {
+  pointers: any[]
+  'health-checks': string[] // array of health check IDs
+}
+
+export interface Manifest extends MarketplaceManifest<DependencyConfig | null> {
+  assets: {
+    license: string // filename
+    instructions: string // filename
+    icon: string // filename
+    docker_images: string // filename
+    assets: string // path to assets folder
+    scripts: string // path to scripts folder
+  }
+  main: ActionImpl
+  'health-checks': Record<
+    string,
+    ActionImpl & { name: string; 'success-message': string | null }
+  >
+  config: ConfigActions | null
+  volumes: Record<string, Volume>
+  'min-os-version': string
+  interfaces: Record<string, InterfaceDef>
+  backup: BackupActions
+  migrations: Migrations | null
+  actions: Record<string, Action>
+}
+
+export interface DependencyConfig {
+  check: ActionImpl
+  'auto-configure': ActionImpl
+}
+
+export interface ActionImpl {
+  type: 'docker'
+  image: string
+  system: boolean
+  entrypoint: string
+  args: string[]
+  mounts: { [id: string]: string }
+  'io-format': DockerIoFormat | null
+  inject: boolean
+  'shm-size': string
+  'sigterm-timeout': string | null
+}
+
+export enum DockerIoFormat {
+  Json = 'json',
+  Yaml = 'yaml',
+  Cbor = 'cbor',
+  Toml = 'toml',
+}
+
+export interface ConfigActions {
+  get: ActionImpl | null
+  set: ActionImpl | null
+}
+
+export type Volume = VolumeData
+
+export interface VolumeData {
+  type: VolumeType.Data
+  readonly: boolean
+}
+
+export interface VolumeAssets {
+  type: VolumeType.Assets
+}
+
+export interface VolumePointer {
+  type: VolumeType.Pointer
+  'package-id': string
+  'volume-id': string
+  path: string
+  readonly: boolean
+}
+
+export interface VolumeCertificate {
+  type: VolumeType.Certificate
+  'interface-id': string
+}
+
+export interface VolumeBackup {
+  type: VolumeType.Backup
+  readonly: boolean
+}
+
+export enum VolumeType {
+  Data = 'data',
+  Assets = 'assets',
+  Pointer = 'pointer',
+  Certificate = 'certificate',
+  Backup = 'backup',
+}
+
+export interface InterfaceDef {
+  name: string
+  description: string
+  'tor-config': TorConfig | null
+  'lan-config': LanConfig | null
+  ui: boolean
+  protocols: string[]
+}
+
+export interface TorConfig {
+  'port-mapping': { [port: number]: number }
+}
+
+export type LanConfig = {
+  [port: number]: { ssl: boolean; mapping: number }
+}
+
+export interface BackupActions {
+  create: ActionImpl
+  restore: ActionImpl
+}
+
+export interface Migrations {
+  from: { [versionRange: string]: ActionImpl }
+  to: { [versionRange: string]: ActionImpl }
+}
+
+export interface Action {
+  name: string
+  description: string
+  warning: string | null
+  implementation: ActionImpl
+  'allowed-statuses': (PackageMainStatus.Stopped | PackageMainStatus.Running)[]
+  'input-spec': ConfigSpec | null
+}
+
+export interface Status {
+  configured: boolean
+  main: MainStatus
+  'dependency-config-errors': { [id: string]: string | null }
+}
+
+export type MainStatus =
+  | MainStatusStopped
+  | MainStatusStopping
+  | MainStatusStarting
+  | MainStatusRunning
+  | MainStatusBackingUp
+  | MainStatusRestarting
+
+export interface MainStatusStopped {
+  status: PackageMainStatus.Stopped
+}
+
+export interface MainStatusStopping {
+  status: PackageMainStatus.Stopping
+}
+
+export interface MainStatusStarting {
+  status: PackageMainStatus.Starting
+  restarting: boolean
+}
+
+export interface MainStatusRunning {
+  status: PackageMainStatus.Running
+  started: string // UTC date string
+  health: { [id: string]: HealthCheckResult }
+}
+
+export interface MainStatusBackingUp {
+  status: PackageMainStatus.BackingUp
+  started: string | null // UTC date string
+}
+
+export interface MainStatusRestarting {
+  status: PackageMainStatus.Restarting
+}
+
+export enum PackageMainStatus {
+  Starting = 'starting',
+  Running = 'running',
+  Stopping = 'stopping',
+  Stopped = 'stopped',
+  BackingUp = 'backing-up',
+  Restarting = 'restarting',
+}
+
+export type HealthCheckResult =
+  | HealthCheckResultStarting
+  | HealthCheckResultLoading
+  | HealthCheckResultDisabled
+  | HealthCheckResultSuccess
+  | HealthCheckResultFailure
+
+export enum HealthResult {
+  Starting = 'starting',
+  Loading = 'loading',
+  Disabled = 'disabled',
+  Success = 'success',
+  Failure = 'failure',
+}
+
+export interface HealthCheckResultStarting {
+  result: HealthResult.Starting
+}
+
+export interface HealthCheckResultDisabled {
+  result: HealthResult.Disabled
+}
+
+export interface HealthCheckResultSuccess {
+  result: HealthResult.Success
+}
+
+export interface HealthCheckResultLoading {
+  result: HealthResult.Loading
+  message: string
+}
+
+export interface HealthCheckResultFailure {
+  result: HealthResult.Failure
+  error: string
+}
+
+export interface InstallProgress {
+  readonly size: number | null
+  readonly downloaded: number
+  readonly 'download-complete': boolean
+  readonly validated: number
+  readonly 'validation-complete': boolean
+  readonly unpacked: number
+  readonly 'unpack-complete': boolean
+}

web/projects/ui/src/app/services/patch-db/local-storage-bootstrap.ts

@@ -0,0 +1,25 @@
+import { Bootstrapper, DBCache } from 'patch-db-client'
+import { DataModel } from 'src/app/services/patch-db/data-model'
+import { Injectable } from '@angular/core'
+import { StorageService } from '../storage.service'
+
+@Injectable({
+  providedIn: 'root',
+})
+export class LocalStorageBootstrap implements Bootstrapper<DataModel> {
+  static CONTENT_KEY = 'patch-db-cache'
+
+  constructor(private readonly storage: StorageService) {}
+
+  init(): DBCache<DataModel> {
+    const cache = this.storage.get<DBCache<DataModel>>(
+      LocalStorageBootstrap.CONTENT_KEY,
+    )
+
+    return cache || { sequence: 0, data: {} as DataModel }
+  }
+
+  update(cache: DBCache<DataModel>): void {
+    this.storage.set(LocalStorageBootstrap.CONTENT_KEY, cache)
+  }
+}

web/projects/ui/src/app/services/patch-db/patch-db.factory.ts

@@ -0,0 +1,57 @@
+import { InjectionToken, Injector } from '@angular/core'
+import {
+  bufferTime,
+  catchError,
+  filter,
+  switchMap,
+  take,
+  tap,
+} from 'rxjs/operators'
+import { Update } from 'patch-db-client'
+import { DataModel } from './data-model'
+import { defer, EMPTY, from, interval, Observable } from 'rxjs'
+import { AuthService } from '../auth.service'
+import { ConnectionService } from '../connection.service'
+import { ApiService } from '../api/embassy-api.service'
+import { ConfigService } from '../config.service'
+
+export const PATCH_SOURCE = new InjectionToken<Observable<Update<DataModel>[]>>(
+  '',
+)
+
+export function sourceFactory(
+  injector: Injector,
+): Observable<Update<DataModel>[]> {
+  // defer() needed to avoid circular dependency with ApiService, since PatchDB is needed there
+  return defer(() => {
+    const api = injector.get(ApiService)
+    const authService = injector.get(AuthService)
+    const connectionService = injector.get(ConnectionService)
+    const configService = injector.get(ConfigService)
+    const isTor = configService.isTor()
+    const timeout = isTor ? 16000 : 4000
+
+    const websocket$ = api.openPatchWebsocket$().pipe(
+      bufferTime(250),
+      filter(updates => !!updates.length),
+      catchError((_, watch$) => {
+        connectionService.websocketConnected$.next(false)
+
+        return interval(timeout).pipe(
+          switchMap(() =>
+            from(api.echo({ message: 'ping', timeout })).pipe(
+              catchError(() => EMPTY),
+            ),
+          ),
+          take(1),
+          switchMap(() => watch$),
+        )
+      }),
+      tap(() => connectionService.websocketConnected$.next(true)),
+    )
+
+    return authService.isVerified$.pipe(
+      switchMap(verified => (verified ? websocket$ : EMPTY)),
+    )
+  })
+}

web/projects/ui/src/app/services/patch-db/patch-db.module.ts

@@ -0,0 +1,20 @@
+import { PatchDB } from 'patch-db-client'
+import { Injector, NgModule } from '@angular/core'
+import { PATCH_SOURCE, sourceFactory } from './patch-db.factory'
+
+// This module is purely for providers organization purposes
+@NgModule({
+  providers: [
+    {
+      provide: PATCH_SOURCE,
+      deps: [Injector],
+      useFactory: sourceFactory,
+    },
+    {
+      provide: PatchDB,
+      deps: [PATCH_SOURCE],
+      useClass: PatchDB,
+    },
+  ],
+})
+export class PatchDbModule {}