fix: recover from smoldot crashes

examples/light-client-extension-helpers-extension/src/background-smoldot.code-split.ts

@@ -14,7 +14,7 @@
 //     plugins: [pluginNodeResolve(), pluginEsbuild()],
 //   }
 
-import { start } from "smoldot"
+import { start } from "@substrate/light-client-extension-helpers/smoldot"
 
 const clientReferencesMaxLogLevel = 3
 

packages/light-client-extension-helpers/package.json

@@ -18,13 +18,13 @@
     "./known-chain-specs/ksmcc3": "./dist/known-chain-specs/ksmcc3.mjs",
     "./known-chain-specs/westend2": "./dist/known-chain-specs/westend2.mjs",
     "./known-chain-specs/rococo_v2_2": "./dist/known-chain-specs/rococo_v2_2.mjs",
-    "./smoldot": "./dist/smoldot/smoldot.mjs"
+    "./smoldot": "./dist/smoldot/index.mjs"
   },
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "tsc --noEmit && tsup-node src/background/background-helper.ts src/content-script/content-script-helper.ts src/extension-page/extension-page-helper.ts src/web-page/web-page-helper.ts src/known-chain-specs/index.ts src/known-chain-specs/polkadot.ts src/known-chain-specs/ksmcc3.ts src/known-chain-specs/westend2.ts src/known-chain-specs/rococo_v2_2.ts src/utils/index.ts src/smoldot/smoldot.ts --clean --sourcemap --platform neutral --target=es2020 --format esm --dts",
+    "build": "tsc --noEmit && tsup-node src/background/background-helper.ts src/content-script/content-script-helper.ts src/extension-page/extension-page-helper.ts src/web-page/web-page-helper.ts src/known-chain-specs/index.ts src/known-chain-specs/polkadot.ts src/known-chain-specs/ksmcc3.ts src/known-chain-specs/westend2.ts src/known-chain-specs/rococo_v2_2.ts src/utils/index.ts src/smoldot/index.ts --clean --sourcemap --platform neutral --target=es2020 --format esm --dts",
     "dev": "pnpm build --watch",
     "lint": "prettier --check README.md \"src/**/*.{js,jsx,ts,tsx,json,md}\""
   },
@@ -37,7 +37,8 @@
     "@types/chrome": "^0.0.266"
   },
   "peerDependencies": {
-    "smoldot": "2.x"
+    "smoldot": "2.x",
+    "effect": "^3.1"
   },
   "dependencies": {
     "@polkadot-api/observable-client": "^0.3.0",

packages/light-client-extension-helpers/src/background/background-helper.ts

@@ -5,7 +5,6 @@ import {
 } from "@polkadot-api/substrate-client"
 import { getObservableClient } from "@polkadot-api/observable-client"
 import { getSyncProvider } from "@polkadot-api/json-rpc-provider-proxy"
-import type { AddChainOptions, Chain, Client } from "smoldot"
 import {
   Observable,
   firstValueFrom,
@@ -24,6 +23,8 @@ import { ALARM, PORT, isSubstrateConnectToExtensionMessage } from "@/shared"
 import { isRpcMessage, type RpcMessage } from "@/utils"
 import * as storage from "@/storage"
 import { createBackgroundRpc } from "./createBackgroundRpc"
+import { Client, Chain, AddChainOptions } from "../smoldot"
+import { supervise } from "../smoldot/tasks"
 
 export type * from "./types"
 
@@ -40,6 +41,8 @@ export const register = ({
   if (isRegistered) throw new Error("helper already registered")
   isRegistered = true
 
+  supervise(smoldotClient)
+
   const wellKnownChainSpecsPromise: Promise<Record<string, string>> =
     getWellKnownChainSpecs().then(async (chainSpecs) =>
       chainSpecs instanceof Array
@@ -375,15 +378,15 @@ export const register = ({
                   disableJsonRpc: false,
                   potentialRelayChains: chain.relayChainGenesisHash
                     ? [
-                        await smoldotClient.addChain({
+                        {
                           chainSpec:
                             chains[chain.relayChainGenesisHash].chainSpec,
                           disableJsonRpc: true,
                           databaseContent: await storage.get({
                             type: "databaseContent",
                             genesisHash: chain.relayChainGenesisHash,
                           }),
-                        }),
+                        },
                       ]
                     : [],
                   databaseContent: await storage.get({
@@ -399,19 +402,22 @@ export const register = ({
                   disableJsonRpc: false,
                   potentialRelayChains: chains[relayChainGenesisHashOrChainId]
                     ? [
-                        await smoldotClient.addChain({
+                        {
                           chainSpec:
                             chains[relayChainGenesisHashOrChainId].chainSpec,
                           disableJsonRpc: true,
                           databaseContent: await storage.get({
                             type: "databaseContent",
                             genesisHash: relayChainGenesisHashOrChainId,
                           }),
-                        }),
+                        },
                       ]
                     : msg.potentialRelayChainIds
                         .filter((chainId) => activeChains[tabId][chainId])
-                        .map((chainId) => activeChains[tabId][chainId].chain),
+                        .map((chainId) => ({
+                          chainSpec: activeChains[tabId][chainId].chainSpec,
+                          disableJsonRpc: true,
+                        })),
                 }
               }
 

packages/light-client-extension-helpers/src/background/json-rpc-provider.ts

@@ -0,0 +1,82 @@
+import type * as smoldot from "../smoldot"
+
+import type { JsonRpcConnection } from "@polkadot-api/json-rpc-provider"
+import { getSyncProvider } from "@polkadot-api/json-rpc-provider-proxy"
+
+export type Client = Pick<smoldot.Client, "addChain">
+export type AddChainOptions = smoldot.AddChainOptions
+
+/**
+ * Adds a chain to check if the add chain options are valid and then
+ * subsequently removes it, so that it is not included in smoldot's internal
+ * reference count.
+ *
+ */
+const validateAddChainOptions = async (
+  client: Client,
+  options: AddChainOptions,
+) => {
+  const chain = await client.addChain(options)
+  try {
+    chain.remove()
+  } catch (_) {}
+}
+
+/**
+ * Creates a new JSON RPC provider using a client and options.
+ *
+ * This provider will automatically re-connect to the chain if the
+ * connection is lost.
+ *
+ * @param client - The client to use for creating the provider.
+ * @param options - The options for adding a chain.
+ */
+export const make = async (client: Client, options: AddChainOptions) => {
+  // The chain that is added in this function is removed only to be added
+  // again when the provider is created. This doesn't matter from a performance
+  // perspective, and is done to keep things simple rather than keep a separate
+  // variable to track whether it is the first time the chain is being added.
+  await validateAddChainOptions(client, options)
+
+  const provider = getSyncProvider(async () => {
+    const chain = await client.addChain(options)
+
+    return (onMessage, onError) => {
+      let connected = true
+      ;(async () => {
+        while (connected) {
+          try {
+            const message = await chain.nextJsonRpcResponse()
+            onMessage(message)
+          } catch (_) {
+            connected = false
+            try {
+              onError()
+            } catch (_) {}
+            break
+          }
+        }
+      })()
+
+      const send: JsonRpcConnection["send"] = (message) => {
+        try {
+          chain.sendJsonRpc(message)
+        } catch (_) {}
+      }
+
+      const disconnect: JsonRpcConnection["disconnect"] = () => {
+        connected = false
+        try {
+          chain.remove()
+        } catch (_) {}
+      }
+
+      return {
+        send,
+        disconnect,
+      }
+    }
+  })
+
+  return provider
+}

packages/light-client-extension-helpers/src/background/smoldot-provider.ts

@@ -1,5 +1,6 @@
 import type { JsonRpcProvider } from "@polkadot-api/json-rpc-provider"
-import type { AddChainOptions, Client } from "smoldot"
+import type { Client, AddChainOptions } from "../smoldot"
+import { make as makeJsonRpcProvider } from "./json-rpc-provider"
 
 type SmoldotProviderOptions =
   | { smoldotClient: Client; addChainOptions: AddChainOptions }
@@ -15,62 +16,25 @@ export const smoldotProvider = async ({
   smoldotClient,
   ...options
 }: SmoldotProviderOptions): Promise<JsonRpcProvider> => {
-  const chain = await smoldotClient.addChain(
+  const provider = await makeJsonRpcProvider(
+    smoldotClient,
     "addChainOptions" in options
       ? options.addChainOptions
       : {
           chainSpec: options.chainSpec,
           disableJsonRpc: false,
           potentialRelayChains: options.relayChainSpec
             ? [
-                await smoldotClient.addChain({
+                {
                   chainSpec: options.relayChainSpec,
                   disableJsonRpc: true,
                   databaseContent: options.relayChainDatabaseContent,
-                }),
+                },
               ]
             : [],
           databaseContent: options.databaseContent,
         },
   )
-  return (onMessage) => {
-    let initialized = false
-    return {
-      disconnect() {
-        try {
-          chain.remove()
-        } catch (error) {
-          console.error("error removing chain", error)
-        }
-      },
-      send(msg: string) {
-        if (!initialized) {
-          initialized = true
-          ;(async () => {
-            while (true) {
-              let jsonRpcResponse
-              try {
-                jsonRpcResponse = await chain.nextJsonRpcResponse()
-              } catch (_) {
-                break
-              }
 
-              // `nextJsonRpcResponse` throws an exception if we pass `disableJsonRpc: true` in the
-              // config. We pass `disableJsonRpc: true` if `jsonRpcCallback` is undefined. Therefore,
-              // this code is never reachable if `jsonRpcCallback` is undefined.
-              try {
-                onMessage(jsonRpcResponse)
-              } catch (error) {
-                console.error(
-                  "JSON-RPC callback has thrown an exception:",
-                  error,
-                )
-              }
-            }
-          })()
-        }
-        chain.sendJsonRpc(msg)
-      },
-    }
-  }
+  return provider
 }

packages/light-client-extension-helpers/src/smoldot/client.ts

@@ -0,0 +1,62 @@
+import * as smoldot from "smoldot"
+import { AddChainOptions, Client, ClientOptions } from "./types"
+
+/**
+ * Wraps a smoldot client to add restart functionality.
+ *
+ * The key difference from the standard smoldot client is how relay chains are
+ * specified. Instead of using `Chain` objects for `potentialRelayChains`,
+ * we use `AddChainOptions`. This is necessary because the `Chain` objects
+ * become invalid after a restart and can't be used in a replay `addChain` call.
+ *
+ * With `AddChainOptions`, we can easily re-add a parachain after a restart by
+ * reusing the same options for each relay chain. Before adding the parachain,
+ * we add the relay chains using their `AddChainOptions` and then remove them
+ * after the parachain is created.
+ *
+ * This ensures the parachain can always be added successfully, as its relay
+ * chain is always added first.
+ */
+export const start = (options?: ClientOptions): Client => {
+  let client = smoldot.start(options)
+  let terminated = false
+
+  const addChain = async (options: AddChainOptions) => {
+    const potentialRelayChains = await Promise.all(
+      options.potentialRelayChains?.map((options) =>
+        client.addChain(options),
+      ) ?? [],
+    )
+
+    const newChain = await client.addChain({
+      ...options,
+      potentialRelayChains,
+    })
+
+    await Promise.all(potentialRelayChains.map((chain) => chain.remove()))
+
+    return newChain
+  }
+
+  const terminate = () => {
+    terminated = true
+    return client.terminate()
+  }
+
+  const restart = async () => {
+    if (terminated) {
+      throw new Error("Cannot restart a terminated client")
+    }
+
+    try {
+      await client.terminate()
+    } catch {}
+    client = smoldot.start(options)
+  }
+
+  return {
+    addChain,
+    restart,
+    terminate,
+  }
+}

packages/light-client-extension-helpers/src/smoldot/index.ts

@@ -0,0 +1,3 @@
+export * from "./client"
+export * from "./types"
+export * from "./tasks"