mirror of
https://github.com/Start9Labs/start-os.git
synced 2026-03-30 04:01:58 +00:00
feat: add getOutboundGateway effect and simplify VersionGraph init/uninit
Add getOutboundGateway effect across core, container-runtime, and SDK to let services query their effective outbound gateway with callback support. Remove preInstall/uninstall hooks from VersionGraph as they are no longer needed.
This commit is contained in:
@@ -135,6 +135,8 @@ export type Effects = {
|
||||
}): Promise<string>
|
||||
/** Returns the IP address of StartOS */
|
||||
getOsIp(): Promise<string>
|
||||
/** Returns the effective outbound gateway for this service */
|
||||
getOutboundGateway(options: { callback?: () => void }): Promise<string>
|
||||
// interface
|
||||
/** Creates an interface bound to a specific host and port to show to the user */
|
||||
exportServiceInterface(options: ExportServiceInterfaceParams): Promise<null>
|
||||
|
||||
4
sdk/base/lib/osBindings/GetOutboundGatewayParams.ts
Normal file
4
sdk/base/lib/osBindings/GetOutboundGatewayParams.ts
Normal file
@@ -0,0 +1,4 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { CallbackId } from './CallbackId'
|
||||
|
||||
export type GetOutboundGatewayParams = { callback?: CallbackId }
|
||||
@@ -110,6 +110,7 @@ export { GetContainerIpParams } from './GetContainerIpParams'
|
||||
export { GetHostInfoParams } from './GetHostInfoParams'
|
||||
export { GetOsAssetParams } from './GetOsAssetParams'
|
||||
export { GetOsVersionParams } from './GetOsVersionParams'
|
||||
export { GetOutboundGatewayParams } from './GetOutboundGatewayParams'
|
||||
export { GetPackageParams } from './GetPackageParams'
|
||||
export { GetPackageResponseFull } from './GetPackageResponseFull'
|
||||
export { GetPackageResponse } from './GetPackageResponse'
|
||||
|
||||
@@ -25,6 +25,7 @@ import { GetSslKeyParams } from '.././osBindings'
|
||||
import { GetServiceInterfaceParams } from '.././osBindings'
|
||||
import { SetDependenciesParams } from '.././osBindings'
|
||||
import { GetSystemSmtpParams } from '.././osBindings'
|
||||
import { GetOutboundGatewayParams } from '.././osBindings'
|
||||
import { GetServicePortForwardParams } from '.././osBindings'
|
||||
import { ExportServiceInterfaceParams } from '.././osBindings'
|
||||
import { ListServiceInterfacesParams } from '.././osBindings'
|
||||
@@ -83,6 +84,7 @@ describe('startosTypeValidation ', () => {
|
||||
getServiceManifest: {} as WithCallback<GetServiceManifestParams>,
|
||||
getSystemSmtp: {} as WithCallback<GetSystemSmtpParams>,
|
||||
getContainerIp: {} as WithCallback<GetContainerIpParams>,
|
||||
getOutboundGateway: {} as WithCallback<GetOutboundGatewayParams>,
|
||||
getOsIp: undefined,
|
||||
getServicePortForward: {} as GetServicePortForwardParams,
|
||||
clearServiceInterfaces: {} as ClearServiceInterfacesParams,
|
||||
|
||||
105
sdk/base/lib/util/GetOutboundGateway.ts
Normal file
105
sdk/base/lib/util/GetOutboundGateway.ts
Normal file
@@ -0,0 +1,105 @@
|
||||
import { Effects } from '../Effects'
|
||||
import { DropGenerator, DropPromise } from './Drop'
|
||||
|
||||
export class GetOutboundGateway {
|
||||
constructor(readonly effects: Effects) {}
|
||||
|
||||
/**
|
||||
* Returns the effective outbound gateway. Reruns the context from which it has been called if the underlying value changes
|
||||
*/
|
||||
const() {
|
||||
return this.effects.getOutboundGateway({
|
||||
callback:
|
||||
this.effects.constRetry &&
|
||||
(() => this.effects.constRetry && this.effects.constRetry()),
|
||||
})
|
||||
}
|
||||
/**
|
||||
* Returns the effective outbound gateway. Does nothing if the value changes
|
||||
*/
|
||||
once() {
|
||||
return this.effects.getOutboundGateway({})
|
||||
}
|
||||
|
||||
private async *watchGen(abort?: AbortSignal) {
|
||||
const resolveCell = { resolve: () => {} }
|
||||
this.effects.onLeaveContext(() => {
|
||||
resolveCell.resolve()
|
||||
})
|
||||
abort?.addEventListener('abort', () => resolveCell.resolve())
|
||||
while (this.effects.isInContext && !abort?.aborted) {
|
||||
let callback: () => void = () => {}
|
||||
const waitForNext = new Promise<void>((resolve) => {
|
||||
callback = resolve
|
||||
resolveCell.resolve = resolve
|
||||
})
|
||||
yield await this.effects.getOutboundGateway({
|
||||
callback: () => callback(),
|
||||
})
|
||||
await waitForNext
|
||||
}
|
||||
return new Promise<never>((_, rej) => rej(new Error('aborted')))
|
||||
}
|
||||
|
||||
/**
|
||||
* Watches the effective outbound gateway. Returns an async iterator that yields whenever the value changes
|
||||
*/
|
||||
watch(abort?: AbortSignal): AsyncGenerator<string, never, unknown> {
|
||||
const ctrl = new AbortController()
|
||||
abort?.addEventListener('abort', () => ctrl.abort())
|
||||
return DropGenerator.of(this.watchGen(ctrl.signal), () => ctrl.abort())
|
||||
}
|
||||
|
||||
/**
|
||||
* Watches the effective outbound gateway. Takes a custom callback function to run whenever the value changes
|
||||
*/
|
||||
onChange(
|
||||
callback: (
|
||||
value: string,
|
||||
error?: Error,
|
||||
) => { cancel: boolean } | Promise<{ cancel: boolean }>,
|
||||
) {
|
||||
;(async () => {
|
||||
const ctrl = new AbortController()
|
||||
for await (const value of this.watch(ctrl.signal)) {
|
||||
try {
|
||||
const res = await callback(value)
|
||||
if (res.cancel) {
|
||||
ctrl.abort()
|
||||
break
|
||||
}
|
||||
} catch (e) {
|
||||
console.error(
|
||||
'callback function threw an error @ GetOutboundGateway.onChange',
|
||||
e,
|
||||
)
|
||||
}
|
||||
}
|
||||
})()
|
||||
.catch((e) => callback('', e))
|
||||
.catch((e) =>
|
||||
console.error(
|
||||
'callback function threw an error @ GetOutboundGateway.onChange',
|
||||
e,
|
||||
),
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* Watches the effective outbound gateway. Returns when the predicate is true
|
||||
*/
|
||||
waitFor(pred: (value: string) => boolean): Promise<string> {
|
||||
const ctrl = new AbortController()
|
||||
return DropPromise.of(
|
||||
Promise.resolve().then(async () => {
|
||||
for await (const next of this.watchGen(ctrl.signal)) {
|
||||
if (pred(next)) {
|
||||
return next
|
||||
}
|
||||
}
|
||||
return ''
|
||||
}),
|
||||
() => ctrl.abort(),
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -14,6 +14,7 @@ export { once } from './once'
|
||||
export { asError } from './asError'
|
||||
export * as Patterns from './patterns'
|
||||
export * from './typeHelpers'
|
||||
export { GetOutboundGateway } from './GetOutboundGateway'
|
||||
export { GetSystemSmtp } from './GetSystemSmtp'
|
||||
export { Graph, Vertex } from './graph'
|
||||
export { inMs } from './inMs'
|
||||
|
||||
Reference in New Issue
Block a user