add callback for getContainerIp (#2851)

* add callback for getContainerIp

* register callback before retrieving info

* version bump; only use backports for linux

sdk/base/lib/Effects.ts

@@ -130,7 +130,10 @@ export type Effects = {
     callback?: () => void
   }): Promise<Host | null>
   /** Returns the IP address of the container */
-  getContainerIp(): Promise<string>
+  getContainerIp(options: {
+    packageId?: PackageId
+    callback?: () => void
+  }): Promise<string>
   /** Returns the IP address of StartOS */
   getOsIp(): Promise<string>
   // interface

sdk/base/lib/osBindings/GetContainerIpParams.ts

@@ -0,0 +1,8 @@
+// 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"
+import type { PackageId } from "./PackageId"
+
+export type GetContainerIpParams = {
+  packageId?: PackageId
+  callback?: CallbackId
+}

sdk/base/lib/osBindings/index.ts

@@ -80,6 +80,7 @@ export { ForgetInterfaceParams } from "./ForgetInterfaceParams"
 export { FullIndex } from "./FullIndex"
 export { FullProgress } from "./FullProgress"
 export { GetActionInputParams } from "./GetActionInputParams"
+export { GetContainerIpParams } from "./GetContainerIpParams"
 export { GetHostInfoParams } from "./GetHostInfoParams"
 export { GetOsAssetParams } from "./GetOsAssetParams"
 export { GetOsVersionParams } from "./GetOsVersionParams"

sdk/base/lib/test/startosTypeValidation.test.ts

@@ -7,6 +7,7 @@ import {
   ClearCallbacksParams,
   ClearServiceInterfacesParams,
   GetActionInputParams,
+  GetContainerIpParams,
   GetStatusParams,
   RequestActionParams,
   RunActionParams,
@@ -77,7 +78,7 @@ describe("startosTypeValidation ", () => {
         set: {} as any, // as SetStoreParams,
       },
       getSystemSmtp: {} as WithCallback<GetSystemSmtpParams>,
-      getContainerIp: undefined,
+      getContainerIp: {} as WithCallback<GetContainerIpParams>,
       getOsIp: undefined,
       getServicePortForward: {} as GetServicePortForwardParams,
       clearServiceInterfaces: {} as ClearServiceInterfacesParams,

sdk/package/lib/StartSdk.ts

@@ -72,7 +72,7 @@ import * as actions from "../../base/lib/actions"
 import { setupInit } from "./inits/setupInit"
 import * as fs from "node:fs/promises"
 
-export const OSVersion = testTypeVersion("0.3.6-alpha.16")
+export const OSVersion = testTypeVersion("0.3.6-alpha.17")
 
 // prettier-ignore
 type AnyNeverCond<T extends any[], Then, Else> = 
@@ -104,7 +104,10 @@ export class StartSdk<Manifest extends T.SDKManifest, Store> {
       | "getHostInfo"
     type MainUsedEffects = "setMainStatus" | "setHealth"
     type CallbackEffects = "constRetry" | "clearCallbacks"
-    type AlreadyExposed = "getSslCertificate" | "getSystemSmtp"
+    type AlreadyExposed =
+      | "getSslCertificate"
+      | "getSystemSmtp"
+      | "getContainerIp"
 
     // prettier-ignore
     type StartSdkEffectWrapper = {
@@ -123,7 +126,6 @@ export class StartSdk<Manifest extends T.SDKManifest, Store> {
       getServicePortForward: (effects, ...args) =>
         effects.getServicePortForward(...args),
       clearBindings: (effects, ...args) => effects.clearBindings(...args),
-      getContainerIp: (effects, ...args) => effects.getContainerIp(...args),
       getOsIp: (effects, ...args) => effects.getOsIp(...args),
       getSslKey: (effects, ...args) => effects.getSslKey(...args),
       setDataVersion: (effects, ...args) => effects.setDataVersion(...args),
@@ -191,7 +193,61 @@ export class StartSdk<Manifest extends T.SDKManifest, Store> {
           opts: { packageId: PackageId },
         ) => getServiceInterfaces(effects, opts),
       },
-
+      getContainerIp: (
+        effects: T.Effects,
+        options: Omit<
+          Parameters<T.Effects["getContainerIp"]>[0],
+          "callback"
+        > = {},
+      ) => {
+        async function* watch() {
+          while (true) {
+            let callback: () => void = () => {}
+            const waitForNext = new Promise<void>((resolve) => {
+              callback = resolve
+            })
+            yield await effects.getContainerIp({ ...options, callback })
+            await waitForNext
+          }
+        }
+        return {
+          const: () =>
+            effects.getContainerIp({
+              ...options,
+              callback:
+                effects.constRetry &&
+                (() => effects.constRetry && effects.constRetry()),
+            }),
+          once: () => effects.getContainerIp(options),
+          watch,
+          onChange: (
+            callback: (
+              value: string | null,
+              error?: Error,
+            ) => void | Promise<void>,
+          ) => {
+            ;(async () => {
+              for await (const value of watch()) {
+                try {
+                  await callback(value)
+                } catch (e) {
+                  console.error(
+                    "callback function threw an error @ getContainerIp.onChange",
+                    e,
+                  )
+                }
+              }
+            })()
+              .catch((e) => callback(null, e))
+              .catch((e) =>
+                console.error(
+                  "callback function threw an error @ getContainerIp.onChange",
+                  e,
+                ),
+              )
+          },
+        }
+      },
       store: {
         get: <E extends Effects, StoreValue = unknown>(
           effects: E,

sdk/package/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@start9labs/start-sdk",
-  "version": "0.3.6-beta.18",
+  "version": "0.3.6-beta.19",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@start9labs/start-sdk",
-      "version": "0.3.6-beta.18",
+      "version": "0.3.6-beta.19",
       "license": "MIT",
       "dependencies": {
         "@iarna/toml": "^2.2.5",

sdk/package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@start9labs/start-sdk",
-  "version": "0.3.6-beta.18",
+  "version": "0.3.6-beta.19",
   "description": "Software development kit to facilitate packaging services for StartOS",
   "main": "./package/lib/index.js",
   "types": "./package/lib/index.d.ts",