Start9/start-os
2
0
Fork 0
mirror of https://github.com/Start9Labs/start-os.git synced 2026-03-30 20:14:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor/actions (#2733)

Browse Source 
* store, properties, manifest

* interfaces

* init and backups

* fix init and backups

* file models

* more versions

* dependencies

* config except dynamic types

* clean up config

* remove disabled from non-dynamic vaues

* actions

* standardize example code block formats

* wip: actions refactor

Co-authored-by: Jade <Blu-J@users.noreply.github.com>

* commit types

* fix types

* update types

* update action request type

* update apis

* add description to actionrequest

* clean up imports

* revert package json

* chore: Remove the recursive to the index

* chore: Remove the other thing I was testing

* flatten action requests

* update container runtime with new config paradigm

* new actions strategy

* seems to be working

* misc backend fixes

* fix fe bugs

* only show breakages if breakages

* only show success modal if result

* don't panic on failed removal

* hide config from actions page

* polyfill autoconfig

* use metadata strategy for actions instead of prev

* misc fixes

* chore: split the sdk into 2 libs (#2736)

* follow sideload progress (#2718)

* follow sideload progress

* small bugfix

* shareReplay with no refcount false

* don't wrap sideload progress in RPCResult

* dont present toast

---------

Co-authored-by: Aiden McClelland <me@drbonez.dev>

* chore: Add the initial of the creation of the two sdk

* chore: Add in the baseDist

* chore: Add in the baseDist

* chore: Get the web and the runtime-container running

* chore: Remove the empty file

* chore: Fix it so the container-runtime works

---------

Co-authored-by: Matt Hill <MattDHill@users.noreply.github.com>
Co-authored-by: Aiden McClelland <me@drbonez.dev>

* misc fixes

* update todos

* minor clean up

* fix link script

* update node version in CI test

* fix node version syntax in ci build

* wip: fixing callbacks

* fix sdk makefile dependencies

* add support for const outside of main

* update apis

* don't panic!

* Chore: Capture weird case on rpc, and log that

* fix procedure id issue

* pass input value for dep auto config

* handle disabled and warning for actions

* chore: Fix for link not having node_modules

* sdk fixes

* fix build

* fix build

* fix build

---------

Co-authored-by: Matt Hill <mattnine@protonmail.com>
Co-authored-by: Jade <Blu-J@users.noreply.github.com>
Co-authored-by: J H <dragondef@gmail.com>
Co-authored-by: Jade <2364004+Blu-J@users.noreply.github.com>
Co-authored-by: Matt Hill <MattDHill@users.noreply.github.com>
This commit is contained in:
Aiden McClelland
2024-09-25 16:12:52 -06:00
committed by GitHub
parent eec5cf6b65
commit db0695126f
469 changed files with 16218 additions and 10485 deletions
Download Patch File Download Diff File Expand all files Collapse all files

159
web/projects/ui/src/app/services/action.service.ts Normal file
View File

@@ -0,0 +1,159 @@
import { Injectable } from '@angular/core'
import { AlertController, ModalController } from '@ionic/angular'
import { ErrorService, LoadingService } from '@start9labs/shared'
import { T } from '@start9labs/start-sdk'
import { ActionSuccessPage } from 'src/app/modals/action-success/action-success.page'
import { RR } from 'src/app/services/api/api.types'
import { ApiService } from 'src/app/services/api/embassy-api.service'
import { FormDialogService } from 'src/app/services/form-dialog.service'
import {
ActionInputModal,
PackageActionData,
} from '../modals/action-input.component'
const allowedStatuses = {
'only-running': new Set(['running']),
'only-stopped': new Set(['stopped']),
any: new Set([
'running',
'stopped',
'restarting',
'restoring',
'stopping',
'starting',
'backingUp',
]),
}
@Injectable({
providedIn: 'root',
})
export class ActionService {
constructor(
private readonly api: ApiService,
private readonly modalCtrl: ModalController,
private readonly alertCtrl: AlertController,
private readonly errorService: ErrorService,
private readonly loader: LoadingService,
private readonly formDialog: FormDialogService,
) {}
async present(
pkgInfo: {
id: string
title: string
mainStatus: T.MainStatus['main']
},
actionInfo: {
id: string
metadata: T.ActionMetadata
},
dependentInfo?: {
title: string
request: T.ActionRequest
},
) {
if (
allowedStatuses[actionInfo.metadata.allowedStatuses].has(
pkgInfo.mainStatus,
)
) {
if (actionInfo.metadata.hasInput) {
this.formDialog.open<PackageActionData>(ActionInputModal, {
label: actionInfo.metadata.name,
data: {
pkgInfo,
actionInfo: {
id: actionInfo.id,
warning: actionInfo.metadata.warning,
},
dependentInfo,
},
})
} else {
const alert = await this.alertCtrl.create({
header: 'Confirm',
message: `Are you sure you want to execute action "${
actionInfo.metadata.name
}"? ${actionInfo.metadata.warning || ''}`,
buttons: [
{
text: 'Cancel',
role: 'cancel',
},
{
text: 'Execute',
handler: () => {
this.execute(pkgInfo.id, actionInfo.id)
},
cssClass: 'enter-click',
},
],
})
await alert.present()
}
} else {
const statuses = [...allowedStatuses[actionInfo.metadata.allowedStatuses]]
const last = statuses.pop()
let statusesStr = statuses.join(', ')
let error = ''
if (statuses.length) {
if (statuses.length > 1) {
// oxford comma
statusesStr += ','
}
statusesStr += ` or ${last}`
} else if (last) {
statusesStr = `${last}`
} else {
error = `There is no status for which this action may be run. This is a bug. Please file an issue with the service maintainer.`
}
const alert = await this.alertCtrl.create({
header: 'Forbidden',
message:
error ||
`Action "${actionInfo.metadata.name}" can only be executed when service is ${statusesStr}`,
buttons: ['OK'],
cssClass: 'alert-error-message enter-click',
})
await alert.present()
}
}
async execute(
packageId: string,
actionId: string,
inputs?: {
prev: RR.GetActionInputRes
curr: object
},
): Promise<boolean> {
const loader = this.loader.open('Executing action...').subscribe()
try {
const res = await this.api.runAction({
packageId,
actionId,
prev: inputs?.prev || null,
input: inputs?.curr || null,
})
if (res) {
const successModal = await this.modalCtrl.create({
component: ActionSuccessPage,
componentProps: {
actionRes: res,
},
})
setTimeout(() => successModal.present(), 500)
}
return true // needed to dismiss original modal/alert
} catch (e: any) {
this.errorService.handleError(e)
return false // don't dismiss original modal/alert
} finally {
loader.unsubscribe()
}
}
}

215
web/projects/ui/src/app/services/api/api.fixures.ts
View File

@@ -6,7 +6,7 @@ import { Metric, NotificationLevel, RR, ServerNotifications } from './api.types'
import { BTC_ICON, LND_ICON, PROXY_ICON, REGISTRY_ICON } from './api-icons'
import { Log } from '@start9labs/shared'
import { configBuilderToSpec } from 'src/app/util/configBuilderToSpec'
import { T, CB } from '@start9labs/start-sdk'
import { T, ISB, IST } from '@start9labs/start-sdk'
import { GetPackagesRes } from '@start9labs/marketplace'
const mockBlake3Commitment: T.Blake3Commitment = {
@@ -112,7 +112,6 @@ export module Mock {
},
osVersion: '0.2.12',
dependencies: {},
hasConfig: true,
images: {
main: {
source: 'packed',
@@ -170,7 +169,6 @@ export module Mock {
s9pk: '',
},
},
hasConfig: true,
images: {
main: {
source: 'packed',
@@ -221,7 +219,6 @@ export module Mock {
s9pk: '',
},
},
hasConfig: false,
images: {
main: {
source: 'packed',
@@ -949,7 +946,8 @@ export module Mock {
},
}
export const ActionResponse: RR.ExecutePackageActionRes = {
export const ActionResponse: T.ActionResult = {
version: '0',
message:
'Password changed successfully. If you lose your new password, you will be lost forever.',
value: 'NewPassword1234!',
@@ -1137,31 +1135,29 @@ export module Mock {
},
}
export const getInputSpec = async (): Promise<
RR.GetPackageConfigRes['spec']
> =>
export const getActionInputSpec = async (): Promise<IST.InputSpec> =>
configBuilderToSpec(
CB.Config.of({
bitcoin: CB.Value.object(
ISB.InputSpec.of({
bitcoin: ISB.Value.object(
{
name: 'Bitcoin Settings',
description:
'RPC and P2P interface configuration options for Bitcoin Core',
},
CB.Config.of({
'bitcoind-p2p': CB.Value.union(
ISB.InputSpec.of({
'bitcoind-p2p': ISB.Value.union(
{
name: 'P2P Settings',
description:
'<p>The Bitcoin Core node to connect to over the peer-to-peer (P2P) interface:</p><ul><li><strong>Bitcoin Core</strong>: The Bitcoin Core service installed on this device</li><li><strong>External Node</strong>: A Bitcoin node running on a different device</li></ul>',
required: { default: 'internal' },
},
CB.Variants.of({
internal: { name: 'Bitcoin Core', spec: CB.Config.of({}) },
ISB.Variants.of({
internal: { name: 'Bitcoin Core', spec: ISB.InputSpec.of({}) },
external: {
name: 'External Node',
spec: CB.Config.of({
'p2p-host': CB.Value.text({
spec: ISB.InputSpec.of({
'p2p-host': ISB.Value.text({
name: 'Public Address',
required: {
default: null,
@@ -1169,7 +1165,7 @@ export module Mock {
description:
'The public address of your Bitcoin Core server',
}),
'p2p-port': CB.Value.number({
'p2p-port': ISB.Value.number({
name: 'P2P Port',
description:
'The port that your Bitcoin Core P2P server is bound to',
@@ -1186,24 +1182,23 @@ export module Mock {
),
}),
),
color: CB.Value.color({
color: ISB.Value.color({
name: 'Color',
required: false,
}),
datetime: CB.Value.datetime({
datetime: ISB.Value.datetime({
name: 'Datetime',
required: false,
}),
file: CB.Value.file({
file: ISB.Value.file({
name: 'File',
required: false,
extensions: ['png', 'pdf'],
}),
users: CB.Value.multiselect({
users: ISB.Value.multiselect({
name: 'Users',
default: [],
maxLength: 2,
disabled: ['matt'],
values: {
matt: 'Matt Hill',
alex: 'Alex Inkin',
@@ -1211,21 +1206,19 @@ export module Mock {
lucy: 'Lucy',
},
}),
advanced: CB.Value.object(
advanced: ISB.Value.object(
{
name: 'Advanced',
description: 'Advanced settings',
},
CB.Config.of({
rpcsettings: CB.Value.object(
ISB.InputSpec.of({
rpcsettings: ISB.Value.object(
{
name: 'RPC Settings',
description: 'rpc username and password',
warning:
'Adding RPC users gives them special permissions on your node.',
},
CB.Config.of({
rpcuser2: CB.Value.text({
ISB.InputSpec.of({
rpcuser2: ISB.Value.text({
name: 'RPC Username',
required: {
default: 'defaultrpcusername',
@@ -1238,7 +1231,7 @@ export module Mock {
},
],
}),
rpcuser: CB.Value.text({
rpcuser: ISB.Value.text({
name: 'RPC Username',
required: {
default: 'defaultrpcusername',
@@ -1251,7 +1244,7 @@ export module Mock {
},
],
}),
rpcpass: CB.Value.text({
rpcpass: ISB.Value.text({
name: 'RPC User Password',
required: {
default: {
@@ -1261,7 +1254,7 @@ export module Mock {
},
description: 'rpc password',
}),
rpcpass2: CB.Value.text({
rpcpass2: ISB.Value.text({
name: 'RPC User Password',
required: {
default: {
@@ -1275,15 +1268,15 @@ export module Mock {
),
}),
),
testnet: CB.Value.toggle({
testnet: ISB.Value.toggle({
name: 'Testnet',
default: true,
description:
'<ul><li>determines whether your node is running on testnet or mainnet</li></ul><script src="fake"></script>',
warning: 'Chain will have to resync!',
}),
'object-list': CB.Value.list(
CB.List.obj(
'object-list': ISB.Value.list(
ISB.List.obj(
{
name: 'Object List',
minLength: 0,
@@ -1295,13 +1288,13 @@ export module Mock {
description: 'This is a list of objects, like users or something',
},
{
spec: CB.Config.of({
'first-name': CB.Value.text({
spec: ISB.InputSpec.of({
'first-name': ISB.Value.text({
name: 'First Name',
required: false,
description: 'User first name',
}),
'last-name': CB.Value.text({
'last-name': ISB.Value.text({
name: 'Last Name',
required: {
default: {
@@ -1317,7 +1310,7 @@ export module Mock {
},
],
}),
age: CB.Value.number({
age: ISB.Value.number({
name: 'Age',
description: 'The age of the user',
warning: 'User must be at least 18.',
@@ -1331,8 +1324,8 @@ export module Mock {
},
),
),
'union-list': CB.Value.list(
CB.List.obj(
'union-list': ISB.Value.list(
ISB.List.obj(
{
name: 'Union List',
minLength: 0,
@@ -1342,27 +1335,27 @@ export module Mock {
warning: 'If you change this, things may work.',
},
{
spec: CB.Config.of({
spec: ISB.InputSpec.of({
/* TODO: Convert range for this value ([0, 2])*/
union: CB.Value.union(
union: ISB.Value.union(
{
name: 'Preference',
description: null,
warning: null,
required: { default: 'summer' },
},
CB.Variants.of({
ISB.Variants.of({
summer: {
name: 'summer',
spec: CB.Config.of({
'favorite-tree': CB.Value.text({
spec: ISB.InputSpec.of({
'favorite-tree': ISB.Value.text({
name: 'Favorite Tree',
required: {
default: 'Maple',
},
description: 'What is your favorite tree?',
}),
'favorite-flower': CB.Value.select({
'favorite-flower': ISB.Value.select({
name: 'Favorite Flower',
description: 'Select your favorite flower',
required: {
@@ -1379,8 +1372,8 @@ export module Mock {
},
winter: {
name: 'winter',
spec: CB.Config.of({
'like-snow': CB.Value.toggle({
spec: ISB.InputSpec.of({
'like-snow': ISB.Value.toggle({
name: 'Like Snow?',
default: true,
description: 'Do you like snow or not?',
@@ -1394,7 +1387,7 @@ export module Mock {
},
),
),
'random-select': CB.Value.select({
'random-select': ISB.Value.dynamicSelect(() => ({
name: 'Random select',
description: 'This is not even real.',
warning: 'Be careful changing this!',
@@ -1407,47 +1400,47 @@ export module Mock {
option3: 'option3',
},
disabled: ['option2'],
}),
})),
'favorite-number':
/* TODO: Convert range for this value ((-100,100])*/ CB.Value.number({
name: 'Favorite Number',
description: 'Your favorite number of all time',
warning:
'Once you set this number, it can never be changed without severe consequences.',
required: {
default: 7,
/* TODO: Convert range for this value ((-100,100])*/ ISB.Value.number(
{
name: 'Favorite Number',
description: 'Your favorite number of all time',
warning:
'Once you set this number, it can never be changed without severe consequences.',
required: {
default: 7,
},
integer: false,
units: 'BTC',
},
integer: false,
units: 'BTC',
}),
rpcsettings: CB.Value.object(
),
rpcsettings: ISB.Value.object(
{
name: 'RPC Settings',
description: 'rpc username and password',
warning:
'Adding RPC users gives them special permissions on your node.',
},
CB.Config.of({
laws: CB.Value.object(
ISB.InputSpec.of({
laws: ISB.Value.object(
{
name: 'Laws',
description: 'the law of the realm',
},
CB.Config.of({
law1: CB.Value.text({
ISB.InputSpec.of({
law1: ISB.Value.text({
name: 'First Law',
required: false,
description: 'the first law',
}),
law2: CB.Value.text({
law2: ISB.Value.text({
name: 'Second Law',
required: false,
description: 'the second law',
}),
}),
),
rulemakers: CB.Value.list(
CB.List.obj(
rulemakers: ISB.Value.list(
ISB.List.obj(
{
name: 'Rule Makers',
minLength: 0,
@@ -1455,8 +1448,8 @@ export module Mock {
description: 'the people who make the rules',
},
{
spec: CB.Config.of({
rulemakername: CB.Value.text({
spec: ISB.InputSpec.of({
rulemakername: ISB.Value.text({
name: 'Rulemaker Name',
required: {
default: {
@@ -1466,7 +1459,7 @@ export module Mock {
},
description: 'the name of the rule maker',
}),
rulemakerip: CB.Value.text({
rulemakerip: ISB.Value.text({
name: 'Rulemaker IP',
required: {
default: '192.168.1.0',
@@ -1484,7 +1477,7 @@ export module Mock {
},
),
),
rpcuser: CB.Value.text({
rpcuser: ISB.Value.text({
name: 'RPC Username',
required: {
default: 'defaultrpcusername',
@@ -1497,7 +1490,7 @@ export module Mock {
},
],
}),
rpcpass: CB.Value.text({
rpcpass: ISB.Value.text({
name: 'RPC User Password',
required: {
default: {
@@ -1510,33 +1503,32 @@ export module Mock {
}),
}),
),
'bitcoin-node': CB.Value.union(
'bitcoin-node': ISB.Value.union(
{
name: 'Bitcoin Node',
description: 'Options<ul><li>Item 1</li><li>Item 2</li></ul>',
warning: 'Careful changing this',
required: { default: 'internal' },
disabled: ['fake'],
},
CB.Variants.of({
ISB.Variants.of({
fake: {
name: 'Fake',
spec: CB.Config.of({}),
spec: ISB.InputSpec.of({}),
},
internal: {
name: 'Internal',
spec: CB.Config.of({}),
spec: ISB.InputSpec.of({}),
},
external: {
name: 'External',
spec: CB.Config.of({
'emergency-contact': CB.Value.object(
spec: ISB.InputSpec.of({
'emergency-contact': ISB.Value.object(
{
name: 'Emergency Contact',
description: 'The person to contact in case of emergency.',
},
CB.Config.of({
name: CB.Value.text({
ISB.InputSpec.of({
name: ISB.Value.text({
name: 'Name',
required: {
default: null,
@@ -1548,7 +1540,7 @@ export module Mock {
},
],
}),
email: CB.Value.text({
email: ISB.Value.text({
name: 'Email',
inputmode: 'email',
required: {
@@ -1557,7 +1549,7 @@ export module Mock {
}),
}),
),
'public-domain': CB.Value.text({
'public-domain': ISB.Value.text({
name: 'Public Domain',
required: {
default: 'bitcoinnode.com',
@@ -1570,7 +1562,7 @@ export module Mock {
},
],
}),
'private-domain': CB.Value.text({
'private-domain': ISB.Value.text({
name: 'Private Domain',
required: {
default: null,
@@ -1583,7 +1575,7 @@ export module Mock {
},
}),
),
port: CB.Value.number({
port: ISB.Value.number({
name: 'Port',
description:
'the default port for your Bitcoin node. default: 8333, testnet: 18333, regtest: 18444',
@@ -1595,7 +1587,7 @@ export module Mock {
step: 1,
integer: true,
}),
'favorite-slogan': CB.Value.text({
'favorite-slogan': ISB.Value.text({
name: 'Favorite Slogan',
generate: {
charset: 'a-z,A-Z,2-9',
@@ -1606,8 +1598,8 @@ export module Mock {
'You most favorite slogan in the whole world, used for paying you.',
masked: true,
}),
rpcallowip: CB.Value.list(
CB.List.text(
rpcallowip: ISB.Value.list(
ISB.List.text(
{
name: 'RPC Allowed IPs',
minLength: 1,
@@ -1629,8 +1621,8 @@ export module Mock {
},
),
),
rpcauth: CB.Value.list(
CB.List.text(
rpcauth: ISB.Value.list(
ISB.List.text(
{
name: 'RPC Auth',
description:
@@ -1694,14 +1686,21 @@ export module Mock {
icon: '/assets/img/service-icons/bitcoind.svg',
lastBackup: null,
status: {
configured: true,
main: {
status: 'running',
started: new Date().toISOString(),
health: {},
main: 'running',
started: new Date().toISOString(),
health: {},
},
actions: {
config: {
name: 'Bitcoin Config',
description: 'edit bitcoin.conf',
warning: null,
visibility: 'enabled',
allowedStatuses: 'any',
hasInput: true,
group: null,
},
},
actions: {},
serviceInterfaces: {
ui: {
id: 'ui',
@@ -1860,6 +1859,7 @@ export module Mock {
storeExposedDependents: [],
registry: 'https://registry.start9.com/',
developerKey: 'developer-key',
requestedActions: {},
}
export const bitcoinProxy: PackageDataEntry<InstalledState> = {
@@ -1871,10 +1871,7 @@ export module Mock {
icon: '/assets/img/service-icons/btc-rpc-proxy.png',
lastBackup: null,
status: {
configured: false,
main: {
status: 'stopped',
},
main: 'stopped',
},
actions: {},
serviceInterfaces: {
@@ -1902,13 +1899,13 @@ export module Mock {
kind: 'running',
versionRange: '>=26.0.0',
healthChecks: [],
configSatisfied: true,
},
},
hosts: {},
storeExposedDependents: [],
registry: 'https://registry.start9.com/',
developerKey: 'developer-key',
requestedActions: {},
}
export const lnd: PackageDataEntry<InstalledState> = {
@@ -1920,10 +1917,7 @@ export module Mock {
icon: '/assets/img/service-icons/lnd.png',
lastBackup: null,
status: {
configured: true,
main: {
status: 'stopped',
},
main: 'stopped',
},
actions: {},
serviceInterfaces: {
@@ -1986,20 +1980,19 @@ export module Mock {
kind: 'running',
versionRange: '>=26.0.0',
healthChecks: [],
configSatisfied: true,
},
'btc-rpc-proxy': {
title: Mock.MockManifestBitcoinProxy.title,
icon: 'assets/img/service-icons/btc-rpc-proxy.png',
kind: 'exists',
versionRange: '>2.0.0',
configSatisfied: false,
},
},
hosts: {},
storeExposedDependents: [],
registry: 'https://registry.start9.com/',
developerKey: 'developer-key',
requestedActions: {},
}
export const LocalPkgs: { [key: string]: PackageDataEntry<InstalledState> } =

52
web/projects/ui/src/app/services/api/api.types.ts
View File

@@ -2,7 +2,7 @@ import { Dump } from 'patch-db-client'
import { PackagePropertiesVersioned } from 'src/app/util/properties.util'
import { DataModel } from 'src/app/services/patch-db/data-model'
import { StartOSDiskInfo, LogsRes, ServerLogsReq } from '@start9labs/shared'
import { CT, T } from '@start9labs/start-sdk'
import { IST, T } from '@start9labs/start-sdk'
import { WebSocketSubjectConfig } from 'rxjs/webSocket'
export module RR {
@@ -72,11 +72,10 @@ export module RR {
export type GetServerLogsReq = ServerLogsReq // server.logs & server.kernel-logs
export type GetServerLogsRes = LogsRes
// @param limit: BE default is 50
// @param boot: number is offset (0: current, -1 prev, +1 first), string is a specific boot id, and null is all
export type FollowServerLogsReq = {
limit?: number
boot?: number | string | null
limit?: number // (optional) default is 50. Ignored if cursor provided
boot?: number | string | null // (optional) number is offset (0: current, -1 prev, +1 first), string is a specific boot id, null is all. Default is undefined
cursor?: string // the last known log. Websocket will return all logs since this log
} // server.logs.follow & server.kernel-logs.follow
export type FollowServerLogsRes = {
startCursor: string
@@ -226,14 +225,19 @@ export module RR {
export type InstallPackageReq = T.InstallParams
export type InstallPackageRes = null
export type GetPackageConfigReq = { id: string } // package.config.get
export type GetPackageConfigRes = { spec: CT.InputSpec; config: object }
export type GetActionInputReq = { packageId: string; actionId: string } // package.action.get-input
export type GetActionInputRes = {
spec: IST.InputSpec
value: object | null
}
export type DrySetPackageConfigReq = { id: string; config: object } // package.config.set.dry
export type DrySetPackageConfigRes = T.PackageId[]
export type SetPackageConfigReq = DrySetPackageConfigReq // package.config.set
export type SetPackageConfigRes = null
export type RunActionReq = {
packageId: string
actionId: string
prev: GetActionInputRes | null
input: object | null
} // package.action.run
export type RunActionRes = T.ActionResult | null
export type RestorePackagesReq = {
// package.backup.restore
@@ -244,13 +248,6 @@ export module RR {
}
export type RestorePackagesRes = null
export type ExecutePackageActionReq = {
id: string
actionId: string
input?: object
} // package.action
export type ExecutePackageActionRes = ActionResponse
export type StartPackageReq = { id: string } // package.start
export type StartPackageRes = null
@@ -263,16 +260,6 @@ export module RR {
export type UninstallPackageReq = { id: string } // package.uninstall
export type UninstallPackageRes = null
export type DryConfigureDependencyReq = {
dependencyId: string
dependentId: string
} // package.dependency.configure.dry
export type DryConfigureDependencyRes = {
oldConfig: object
newConfig: object
spec: CT.InputSpec
}
export type SideloadPackageReq = {
manifest: T.Manifest
icon: string // base64
@@ -306,13 +293,6 @@ export interface TaggedDependencyError {
error: DependencyError
}
export interface ActionResponse {
message: string
value: string | null
copyable: boolean
qr: boolean
}
interface MetricData {
value: string
unit: string

22
web/projects/ui/src/app/services/api/embassy-api.service.ts
View File

@@ -231,26 +231,16 @@ export abstract class ApiService {
params: RR.InstallPackageReq,
): Promise<RR.InstallPackageRes>
abstract getPackageConfig(
params: RR.GetPackageConfigReq,
): Promise<RR.GetPackageConfigRes>
abstract getActionInput(
params: RR.GetActionInputReq,
): Promise<RR.GetActionInputRes>
abstract drySetPackageConfig(
params: RR.DrySetPackageConfigReq,
): Promise<RR.DrySetPackageConfigRes>
abstract setPackageConfig(
params: RR.SetPackageConfigReq,
): Promise<RR.SetPackageConfigRes>
abstract runAction(params: RR.RunActionReq): Promise<RR.RunActionRes>
abstract restorePackages(
params: RR.RestorePackagesReq,
): Promise<RR.RestorePackagesRes>
abstract executePackageAction(
params: RR.ExecutePackageActionReq,
): Promise<RR.ExecutePackageActionRes>
abstract startPackage(params: RR.StartPackageReq): Promise<RR.StartPackageRes>
abstract restartPackage(
@@ -263,9 +253,5 @@ export abstract class ApiService {
params: RR.UninstallPackageReq,
): Promise<RR.UninstallPackageRes>
abstract dryConfigureDependency(
params: RR.DryConfigureDependencyReq,
): Promise<RR.DryConfigureDependencyRes>
abstract sideloadPackage(): Promise<RR.SideloadPackageRes>
}

35
web/projects/ui/src/app/services/api/embassy-live-api.service.ts
View File

@@ -468,22 +468,14 @@ export class LiveApiService extends ApiService {
return this.rpcRequest({ method: 'package.install', params })
}
async getPackageConfig(
params: RR.GetPackageConfigReq,
): Promise<RR.GetPackageConfigRes> {
return this.rpcRequest({ method: 'package.config.get', params })
async getActionInput(
params: RR.GetActionInputReq,
): Promise<RR.GetActionInputRes> {
return this.rpcRequest({ method: 'package.action.get-input', params })
}
async drySetPackageConfig(
params: RR.DrySetPackageConfigReq,
): Promise<RR.DrySetPackageConfigRes> {
return this.rpcRequest({ method: 'package.config.set.dry', params })
}
async setPackageConfig(
params: RR.SetPackageConfigReq,
): Promise<RR.SetPackageConfigRes> {
return this.rpcRequest({ method: 'package.config.set', params })
async runAction(params: RR.RunActionReq): Promise<RR.RunActionRes> {
return this.rpcRequest({ method: 'package.action.run', params })
}
async restorePackages(
@@ -492,12 +484,6 @@ export class LiveApiService extends ApiService {
return this.rpcRequest({ method: 'package.backup.restore', params })
}
async executePackageAction(
params: RR.ExecutePackageActionReq,
): Promise<RR.ExecutePackageActionRes> {
return this.rpcRequest({ method: 'package.action', params })
}
async startPackage(params: RR.StartPackageReq): Promise<RR.StartPackageRes> {
return this.rpcRequest({ method: 'package.start', params })
}
@@ -518,15 +504,6 @@ export class LiveApiService extends ApiService {
return this.rpcRequest({ method: 'package.uninstall', params })
}
async dryConfigureDependency(
params: RR.DryConfigureDependencyReq,
): Promise<RR.DryConfigureDependencyRes> {
return this.rpcRequest({
method: 'package.dependency.configure.dry',
params,
})
}
async sideloadPackage(): Promise<RR.SideloadPackageRes> {
return this.rpcRequest({
method: 'package.sideload',

50
web/projects/ui/src/app/services/api/embassy-mock-api.service.ts
View File

@@ -780,37 +780,19 @@ export class MockApiService extends ApiService {
return null
}
async getPackageConfig(
params: RR.GetPackageConfigReq,
): Promise<RR.GetPackageConfigRes> {
async getActionInput(
params: RR.GetActionInputReq,
): Promise<RR.GetActionInputRes> {
await pauseFor(2000)
return {
config: Mock.MockConfig,
spec: await Mock.getInputSpec(),
value: Mock.MockConfig,
spec: await Mock.getActionInputSpec(),
}
}
async drySetPackageConfig(
params: RR.DrySetPackageConfigReq,
): Promise<RR.DrySetPackageConfigRes> {
async runAction(params: RR.RunActionReq): Promise<RR.RunActionRes> {
await pauseFor(2000)
return []
}
async setPackageConfig(
params: RR.SetPackageConfigReq,
): Promise<RR.SetPackageConfigRes> {
await pauseFor(2000)
const patch = [
{
op: PatchOp.REPLACE,
path: `/packageData/${params.id}/status/configured`,
value: true,
},
]
this.mockRevision(patch)
return null
return Mock.ActionResponse
}
async restorePackages(
@@ -843,13 +825,6 @@ export class MockApiService extends ApiService {
return null
}
async executePackageAction(
params: RR.ExecutePackageActionReq,
): Promise<RR.ExecutePackageActionRes> {
await pauseFor(2000)
return Mock.ActionResponse
}
async startPackage(params: RR.StartPackageReq): Promise<RR.StartPackageRes> {
const path = `/packageData/${params.id}/status/main`
@@ -1069,17 +1044,6 @@ export class MockApiService extends ApiService {
return null
}
async dryConfigureDependency(
params: RR.DryConfigureDependencyReq,
): Promise<RR.DryConfigureDependencyRes> {
await pauseFor(2000)
return {
oldConfig: Mock.MockConfig,
newConfig: Mock.MockDependencyConfig,
spec: await Mock.getInputSpec(),
}
}
async sideloadPackage(): Promise<RR.SideloadPackageRes> {
await pauseFor(2000)
return {

78
web/projects/ui/src/app/services/api/mock-patch.ts
View File

@@ -96,40 +96,47 @@ export const mockPatchData: DataModel = {
icon: '/assets/img/service-icons/bitcoind.svg',
lastBackup: null,
status: {
configured: true,
main: {
status: 'running',
started: '2021-06-14T20:49:17.774Z',
health: {
'ephemeral-health-check': {
name: 'Ephemeral Health Check',
result: 'starting',
message: null,
},
'chain-state': {
name: 'Chain State',
result: 'loading',
message: 'Bitcoin is syncing from genesis',
},
'p2p-interface': {
name: 'P2P',
result: 'success',
message: 'Health check successful',
},
'rpc-interface': {
name: 'RPC',
result: 'failure',
message: 'RPC interface unreachable.',
},
'unnecessary-health-check': {
name: 'Unnecessary Health Check',
result: 'disabled',
message: null,
},
main: 'running',
started: '2021-06-14T20:49:17.774Z',
health: {
'ephemeral-health-check': {
name: 'Ephemeral Health Check',
result: 'starting',
message: null,
},
'chain-state': {
name: 'Chain State',
result: 'loading',
message: 'Bitcoin is syncing from genesis',
},
'p2p-interface': {
name: 'P2P',
result: 'success',
message: 'Health check successful',
},
'rpc-interface': {
name: 'RPC',
result: 'failure',
message: 'RPC interface unreachable.',
},
'unnecessary-health-check': {
name: 'Unnecessary Health Check',
result: 'disabled',
message: null,
},
},
},
actions: {},
actions: {
config: {
name: 'Bitcoin Config',
description: 'edit bitcoin.conf',
warning: null,
visibility: 'enabled',
allowedStatuses: 'any',
hasInput: true,
group: null,
},
},
serviceInterfaces: {
ui: {
id: 'ui',
@@ -288,6 +295,7 @@ export const mockPatchData: DataModel = {
storeExposedDependents: [],
registry: 'https://registry.start9.com/',
developerKey: 'developer-key',
requestedActions: {},
},
lnd: {
stateInfo: {
@@ -301,10 +309,7 @@ export const mockPatchData: DataModel = {
icon: '/assets/img/service-icons/lnd.png',
lastBackup: null,
status: {
configured: true,
main: {
status: 'stopped',
},
main: 'stopped',
},
actions: {},
serviceInterfaces: {
@@ -367,7 +372,6 @@ export const mockPatchData: DataModel = {
kind: 'running',
versionRange: '>=26.0.0',
healthChecks: [],
configSatisfied: true,
},
'btc-rpc-proxy': {
title: 'Bitcoin Proxy',
@@ -375,13 +379,13 @@ export const mockPatchData: DataModel = {
kind: 'running',
versionRange: '>2.0.0',
healthChecks: [],
configSatisfied: false,
},
},
hosts: {},
storeExposedDependents: [],
registry: 'https://registry.start9.com/',
developerKey: 'developer-key',
requestedActions: {},
},
},
}

2
web/projects/ui/src/app/services/config.service.ts
View File

@@ -51,7 +51,7 @@ export class ConfigService {
isLaunchable(
state: T.PackageState['state'],
status: T.MainStatus['status'],
status: T.MainStatus['main'],
): boolean {
return state === 'installed' && status === 'running'
}

13
web/projects/ui/src/app/services/dep-error.service.ts
View File

@@ -102,13 +102,20 @@ export class DepErrorService {
}
// invalid config
if (!currentDep.configSatisfied) {
if (
Object.values(pkg.requestedActions).some(
a =>
a.active &&
a.request.packageId === depId &&
a.request.actionId === 'config',
)
) {
return {
type: 'configUnsatisfied',
}
}
const depStatus = dep.status.main.status
const depStatus = dep.status.main
// not running
if (depStatus !== 'running' && depStatus !== 'starting') {
@@ -120,7 +127,7 @@ export class DepErrorService {
// health check failure
if (depStatus === 'running' && currentDep.kind === 'running') {
for (let id of currentDep.healthChecks) {
const check = dep.status.main.health[id]
const check = dep.status.health[id]
if (check?.result !== 'success') {
return {
type: 'healthChecksFailed',

90
web/projects/ui/src/app/services/form.service.ts
View File

@@ -7,7 +7,7 @@ import {
ValidatorFn,
Validators,
} from '@angular/forms'
import { CT, utils } from '@start9labs/start-sdk'
import { IST, utils } from '@start9labs/start-sdk'
const Mustache = require('mustache')
@Injectable({
@@ -17,16 +17,16 @@ export class FormService {
constructor(private readonly formBuilder: UntypedFormBuilder) {}
createForm(
spec: CT.InputSpec,
spec: IST.InputSpec,
current: Record<string, any> = {},
): UntypedFormGroup {
return this.getFormGroup(spec, [], current)
}
getUnionSelectSpec(
spec: CT.ValueSpecUnion,
spec: IST.ValueSpecUnion,
selection: string | null,
): CT.ValueSpecSelect {
): IST.ValueSpecSelect {
return {
...spec,
type: 'select',
@@ -38,7 +38,7 @@ export class FormService {
}
getUnionObject(
spec: CT.ValueSpecUnion,
spec: IST.ValueSpecUnion,
selected: string | null,
): UntypedFormGroup {
const group = this.getFormGroup({
@@ -53,16 +53,16 @@ export class FormService {
return group
}
getListItem(spec: CT.ValueSpecList, entry?: any) {
if (CT.isValueSpecListOf(spec, 'text')) {
getListItem(spec: IST.ValueSpecList, entry?: any) {
if (IST.isValueSpecListOf(spec, 'text')) {
return this.formBuilder.control(entry, stringValidators(spec.spec))
} else if (CT.isValueSpecListOf(spec, 'object')) {
} else if (IST.isValueSpecListOf(spec, 'object')) {
return this.getFormGroup(spec.spec.spec, [], entry)
}
}
getFormGroup(
config: CT.InputSpec,
config: IST.InputSpec,
validators: ValidatorFn[] = [],
current?: Record<string, any> | null,
): UntypedFormGroup {
@@ -77,7 +77,7 @@ export class FormService {
}
private getFormEntry(
spec: CT.ValueSpec,
spec: IST.ValueSpec,
currentValue?: any,
): UntypedFormGroup | UntypedFormArray | UntypedFormControl {
let value: any
@@ -145,18 +145,18 @@ export class FormService {
}
}
// function getListItemValidators(spec: CT.ValueSpecList) {
// if (CT.isValueSpecListOf(spec, 'text')) {
// function getListItemValidators(spec: IST.ValueSpecList) {
// if (IST.isValueSpecListOf(spec, 'text')) {
// return stringValidators(spec.spec)
// }
// }
function stringValidators(
spec: CT.ValueSpecText | CT.ListValueSpecText,
spec: IST.ValueSpecText | IST.ListValueSpecText,
): ValidatorFn[] {
const validators: ValidatorFn[] = []
if ((spec as CT.ValueSpecText).required) {
if ((spec as IST.ValueSpecText).required) {
validators.push(Validators.required)
}
@@ -169,7 +169,7 @@ function stringValidators(
return validators
}
function textareaValidators(spec: CT.ValueSpecTextarea): ValidatorFn[] {
function textareaValidators(spec: IST.ValueSpecTextarea): ValidatorFn[] {
const validators: ValidatorFn[] = []
if (spec.required) {
@@ -181,7 +181,7 @@ function textareaValidators(spec: CT.ValueSpecTextarea): ValidatorFn[] {
return validators
}
function colorValidators({ required }: CT.ValueSpecColor): ValidatorFn[] {
function colorValidators({ required }: IST.ValueSpecColor): ValidatorFn[] {
const validators: ValidatorFn[] = [Validators.pattern(/^#[0-9a-f]{6}$/i)]
if (required) {
@@ -195,7 +195,7 @@ function datetimeValidators({
required,
min,
max,
}: CT.ValueSpecDatetime): ValidatorFn[] {
}: IST.ValueSpecDatetime): ValidatorFn[] {
const validators: ValidatorFn[] = []
if (required) {
@@ -213,12 +213,12 @@ function datetimeValidators({
return validators
}
function numberValidators(spec: CT.ValueSpecNumber): ValidatorFn[] {
function numberValidators(spec: IST.ValueSpecNumber): ValidatorFn[] {
const validators: ValidatorFn[] = []
validators.push(isNumber())
if ((spec as CT.ValueSpecNumber).required) {
if ((spec as IST.ValueSpecNumber).required) {
validators.push(Validators.required)
}
@@ -231,7 +231,7 @@ function numberValidators(spec: CT.ValueSpecNumber): ValidatorFn[] {
return validators
}
function selectValidators(spec: CT.ValueSpecSelect): ValidatorFn[] {
function selectValidators(spec: IST.ValueSpecSelect): ValidatorFn[] {
const validators: ValidatorFn[] = []
if (spec.required) {
@@ -241,13 +241,13 @@ function selectValidators(spec: CT.ValueSpecSelect): ValidatorFn[] {
return validators
}
function multiselectValidators(spec: CT.ValueSpecMultiselect): ValidatorFn[] {
function multiselectValidators(spec: IST.ValueSpecMultiselect): ValidatorFn[] {
const validators: ValidatorFn[] = []
validators.push(listInRange(spec.minLength, spec.maxLength))
return validators
}
function listValidators(spec: CT.ValueSpecList): ValidatorFn[] {
function listValidators(spec: IST.ValueSpecList): ValidatorFn[] {
const validators: ValidatorFn[] = []
validators.push(listInRange(spec.minLength, spec.maxLength))
validators.push(listItemIssue())
@@ -352,7 +352,7 @@ export function listItemIssue(): ValidatorFn {
}
}
export function listUnique(spec: CT.ValueSpecList): ValidatorFn {
export function listUnique(spec: IST.ValueSpecList): ValidatorFn {
return control => {
const list = control.value
for (let idx = 0; idx < list.length; idx++) {
@@ -389,7 +389,11 @@ export function listUnique(spec: CT.ValueSpecList): ValidatorFn {
}
}
function listItemEquals(spec: CT.ValueSpecList, val1: any, val2: any): boolean {
function listItemEquals(
spec: IST.ValueSpecList,
val1: any,
val2: any,
): boolean {
// TODO: fix types
switch (spec.spec.type) {
case 'text':
@@ -402,7 +406,7 @@ function listItemEquals(spec: CT.ValueSpecList, val1: any, val2: any): boolean {
}
}
function itemEquals(spec: CT.ValueSpec, val1: any, val2: any): boolean {
function itemEquals(spec: IST.ValueSpec, val1: any, val2: any): boolean {
switch (spec.type) {
case 'text':
case 'textarea':
@@ -414,15 +418,15 @@ function itemEquals(spec: CT.ValueSpec, val1: any, val2: any): boolean {
// TODO: 'unique-by' does not exist on ValueSpecObject, fix types
return objEquals(
(spec as any)['unique-by'],
spec as CT.ValueSpecObject,
spec as IST.ValueSpecObject,
val1,
val2,
)
case 'union':
// TODO: 'unique-by' does not exist on CT.ValueSpecUnion, fix types
// TODO: 'unique-by' does not exist onIST.ValueSpecUnion, fix types
return unionEquals(
(spec as any)['unique-by'],
spec as CT.ValueSpecUnion,
spec as IST.ValueSpecUnion,
val1,
val2,
)
@@ -442,8 +446,8 @@ function itemEquals(spec: CT.ValueSpec, val1: any, val2: any): boolean {
}
function listObjEquals(
uniqueBy: CT.UniqueBy,
spec: CT.ListValueSpecObject,
uniqueBy: IST.UniqueBy,
spec: IST.ListValueSpecObject,
val1: any,
val2: any,
): boolean {
@@ -470,8 +474,8 @@ function listObjEquals(
}
function objEquals(
uniqueBy: CT.UniqueBy,
spec: CT.ValueSpecObject,
uniqueBy: IST.UniqueBy,
spec: IST.ValueSpecObject,
val1: any,
val2: any,
): boolean {
@@ -499,8 +503,8 @@ function objEquals(
}
function unionEquals(
uniqueBy: CT.UniqueBy,
spec: CT.ValueSpecUnion,
uniqueBy: IST.UniqueBy,
spec: IST.ValueSpecUnion,
val1: any,
val2: any,
): boolean {
@@ -532,8 +536,8 @@ function unionEquals(
}
function uniqueByMessageWrapper(
uniqueBy: CT.UniqueBy,
spec: CT.ListValueSpecObject,
uniqueBy: IST.UniqueBy,
spec: IST.ListValueSpecObject,
) {
let configSpec = spec.spec
@@ -544,8 +548,8 @@ function uniqueByMessageWrapper(
}
function uniqueByMessage(
uniqueBy: CT.UniqueBy,
configSpec: CT.InputSpec,
uniqueBy: IST.UniqueBy,
configSpec: IST.InputSpec,
outermost = true,
): string {
let joinFunc
@@ -554,7 +558,7 @@ function uniqueByMessage(
return ''
} else if (typeof uniqueBy === 'string') {
return configSpec[uniqueBy]
? (configSpec[uniqueBy] as CT.ValueSpecObject).name
? (configSpec[uniqueBy] as IST.ValueSpecObject).name
: uniqueBy
} else if ('any' in uniqueBy) {
joinFunc = ' OR '
@@ -574,14 +578,14 @@ function uniqueByMessage(
}
function isObject(
spec: CT.ListValueSpecOf<any>,
): spec is CT.ListValueSpecObject {
spec: IST.ListValueSpecOf<any>,
): spec is IST.ListValueSpecObject {
// only lists of objects have uniqueBy
return 'uniqueBy' in spec
}
export function convertValuesRecursive(
configSpec: CT.InputSpec,
configSpec: IST.InputSpec,
group: UntypedFormGroup,
) {
Object.entries(configSpec).forEach(([key, valueSpec]) => {
@@ -611,7 +615,7 @@ export function convertValuesRecursive(
})
} else if (valueSpec.spec.type === 'object') {
controls.forEach(formGroup => {
const objectSpec = valueSpec.spec as CT.ListValueSpecObject
const objectSpec = valueSpec.spec as IST.ListValueSpecObject
convertValuesRecursive(objectSpec.spec, formGroup as UntypedFormGroup)
})
}

15
web/projects/ui/src/app/services/pkg-status-rendering.service.ts
View File

@@ -1,6 +1,7 @@
import { PackageDataEntry } from 'src/app/services/patch-db/data-model'
import { PkgDependencyErrors } from './dep-error.service'
import { T } from '@start9labs/start-sdk'
import { getManifest, needsConfig } from '../util/get-package-data'
export interface PackageStatus {
primary: PrimaryStatus
@@ -17,7 +18,7 @@ export function renderPkgStatus(
let health: T.HealthStatus | null = null
if (pkg.stateInfo.state === 'installed') {
primary = getInstalledPrimaryStatus(pkg.status)
primary = getInstalledPrimaryStatus(pkg)
dependency = getDependencyStatus(depErrors)
health = getHealthStatus(pkg.status)
} else {
@@ -27,11 +28,11 @@ export function renderPkgStatus(
return { primary, dependency, health }
}
function getInstalledPrimaryStatus(status: T.Status): PrimaryStatus {
if (!status.configured) {
function getInstalledPrimaryStatus(pkg: T.PackageDataEntry): PrimaryStatus {
if (needsConfig(getManifest(pkg).id, pkg.requestedActions)) {
return 'needsConfig'
} else {
return status.main.status as any as PrimaryStatus
return pkg.status.main
}
}
@@ -39,12 +40,12 @@ function getDependencyStatus(depErrors: PkgDependencyErrors): DependencyStatus {
return Object.values(depErrors).some(err => !!err) ? 'warning' : 'satisfied'
}
function getHealthStatus(status: T.Status): T.HealthStatus | null {
if (status.main.status !== 'running' || !status.main.health) {
function getHealthStatus(status: T.MainStatus): T.HealthStatus | null {
if (status.main !== 'running' || !status.main) {
return null
}
const values = Object.values(status.main.health)
const values = Object.values(status.health)
if (values.some(h => h.result === 'failure')) {
return 'failure'