Add identity deletion to the CLI

src/ConnectorRuntime.ts

@@ -341,7 +341,7 @@ export class ConnectorRuntime extends Runtime<ConnectorRuntimeConfig> {
         }
     }
 
-    protected async stop(): Promise<void> {
+    public async stop(): Promise<void> {
         if (this.isStarted) {
             try {
                 await super.stop();

src/cli/BaseCommand.ts

@@ -1,7 +1,10 @@
 import yargs from "yargs";
+import { ConnectorRuntime } from "../ConnectorRuntime";
+import { ConnectorRuntimeConfig } from "../ConnectorRuntimeConfig";
+import { createConnectorConfig } from "../CreateConnectorConfig";
 
 export interface ConfigFileOptions {
-    config: string | undefined;
+    config?: string;
 }
 
 export const configOptionBuilder = (yargs: yargs.Argv<{}>): yargs.Argv<ConfigFileOptions> => {
@@ -13,3 +16,47 @@ Can also be set via the CUSTOM_CONFIG_LOCATION env variable`,
         demandOption: false
     });
 };
+
+export abstract class BaseCommand {
+    private connectorConfig?: ConnectorRuntimeConfig;
+    protected cliRuntime?: ConnectorRuntime;
+    protected log = console;
+
+    public async run(configPath: string | undefined): Promise<any> {
+        if (configPath) {
+            process.env.CUSTOM_CONFIG_LOCATION = configPath;
+        }
+
+        try {
+            this.connectorConfig = createConnectorConfig();
+            this.connectorConfig.infrastructure.httpServer.enabled = false;
+            this.connectorConfig.modules.coreHttpApi.enabled = false;
+            this.connectorConfig.logging = {
+                appenders: {
+                    console: { type: "console" }
+                },
+                categories: {
+                    default: { appenders: ["console"], level: "OFF" }
+                }
+            };
+            return await this.runInternal(this.connectorConfig);
+        } catch (error: any) {
+            this.log.log("Error creating identity: ", error);
+        } finally {
+            if (this.cliRuntime) {
+                await this.cliRuntime.stop();
+            }
+        }
+    }
+
+    protected async createRuntime(): Promise<void> {
+        if (this.cliRuntime) {
+            return;
+        }
+        if (!this.connectorConfig) throw new Error("Connector config not initialized");
+        this.cliRuntime = await ConnectorRuntime.create(this.connectorConfig);
+        await this.cliRuntime.start();
+    }
+
+    protected abstract runInternal(connectorConfig: ConnectorRuntimeConfig): Promise<void>;
+}

src/cli/commands/identity/status.ts

@@ -0,0 +1,40 @@
+import { DateTime } from "luxon";
+import { CommandModule } from "yargs";
+import { BaseCommand, ConfigFileOptions, configOptionBuilder } from "../../BaseCommand";
+
+export const identityStatusHandler = async ({ config }: ConfigFileOptions): Promise<void> => {
+    await new IdentityStatus().run(config);
+};
+export const yargsIdentityStatusCommand: CommandModule<{}, ConfigFileOptions> = {
+    command: "status",
+    describe: "show the status of the identity",
+    handler: identityStatusHandler,
+    builder: configOptionBuilder
+};
+
+export class IdentityStatus extends BaseCommand {
+    protected async runInternal(): Promise<void> {
+        await this.createRuntime();
+        if (!this.cliRuntime) {
+            throw new Error("Failed to inizitialize runtime");
+        }
+
+        try {
+            const identityInfoResult = await this.cliRuntime.getServices().transportServices.account.getIdentityInfo();
+            const identityDeletionProcessesResult = await this.cliRuntime.getServices().transportServices.identityDeletionProcesses.getActiveIdentityDeletionProcess();
+
+            const identityInfo = identityInfoResult.value;
+            let message = `Id: ${identityInfo.address}`;
+
+            if (identityDeletionProcessesResult.isSuccess) {
+                const identityDeletionProcesses = identityDeletionProcessesResult.value;
+                message += `\nIdentity deletion status: ${identityDeletionProcesses.status}`;
+                message += `\nEnd of approval period: ${DateTime.fromISO(identityDeletionProcesses.approvalPeriodEndsAt ?? "").toLocaleString()}`;
+                message += `\nEnd of grace period: ${DateTime.fromISO(identityDeletionProcesses.gracePeriodEndsAt ?? "").toLocaleString()}`;
+            }
+            this.log.log(message);
+        } catch (e: any) {
+            this.log.error(e);
+        }
+    }
+}

src/cli/commands/identityDeletion/cancel.ts

@@ -0,0 +1,29 @@
+import { CommandModule } from "yargs";
+import { BaseCommand, ConfigFileOptions, configOptionBuilder } from "../../BaseCommand";
+
+export const identityDeletionCancelHandler = async ({ config }: ConfigFileOptions): Promise<void> => {
+    await new CancelIdentityDeletion().run(config);
+};
+export const yargsIdentityDeletionCancelCommand: CommandModule<{}, ConfigFileOptions> = {
+    command: "cancel",
+    describe: "cancel the identity deletion",
+    handler: identityDeletionCancelHandler,
+    builder: configOptionBuilder
+};
+
+export default class CancelIdentityDeletion extends BaseCommand {
+    protected async runInternal(): Promise<void> {
+        await this.createRuntime();
+        if (!this.cliRuntime) {
+            throw new Error("Failed to initialize runtime");
+        }
+
+        const identityDeletionCancelationResult = await this.cliRuntime.getServices().transportServices.identityDeletionProcesses.cancelIdentityDeletionProcess();
+
+        if (identityDeletionCancelationResult.isSuccess) {
+            this.log.log("Identity deletion canceled");
+            return;
+        }
+        this.log.log(identityDeletionCancelationResult.error.toString());
+    }
+}

src/cli/commands/identityDeletion/init.ts

@@ -0,0 +1,30 @@
+import { CommandModule } from "yargs";
+import { BaseCommand, ConfigFileOptions, configOptionBuilder } from "../../BaseCommand";
+
+export const identityDeletionInitHandler = async ({ config }: ConfigFileOptions): Promise<void> => {
+    const command = new InitIdentityDeletion();
+    await command.run(config);
+};
+export const yargsIdentityDeletionInitCommand: CommandModule<{}, ConfigFileOptions> = {
+    command: "init",
+    describe: "initialize the identity deletion",
+    handler: identityDeletionInitHandler,
+    builder: configOptionBuilder
+};
+
+export default class InitIdentityDeletion extends BaseCommand {
+    protected async runInternal(): Promise<void> {
+        await this.createRuntime();
+        if (!this.cliRuntime) {
+            throw new Error("Failed to initialize runtime");
+        }
+
+        const identityDeletionInitResult = await this.cliRuntime.getServices().transportServices.identityDeletionProcesses.initiateIdentityDeletionProcess();
+
+        if (identityDeletionInitResult.isSuccess) {
+            this.log.log("Identity deletion initiated");
+            return;
+        }
+        this.log.error(identityDeletionInitResult.error.toString());
+    }
+}

src/cli/commands/index.ts

@@ -1 +1,4 @@
+export * from "./identity/status";
+export * from "./identityDeletion/cancel";
+export * from "./identityDeletion/init";
 export * from "./startConnector";

src/index.ts

@@ -2,9 +2,29 @@
 
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
-import { startConnectorCommand } from "./cli/commands";
+import { startConnectorCommand, yargsIdentityDeletionCancelCommand, yargsIdentityDeletionInitCommand, yargsIdentityStatusCommand } from "./cli/commands";
 
 yargs(hideBin(process.argv))
+    .command({
+        command: "identity [command]",
+        describe: "Identity related commands",
+        builder: (yargs) => {
+            return yargs.command(yargsIdentityStatusCommand);
+        },
+        handler: () => {
+            yargs.showHelp("log");
+        }
+    })
+    .command({
+        command: "identityDeletion [command]",
+        describe: "Identity deletion related commands",
+        builder: (yargs) => {
+            return yargs.command(yargsIdentityDeletionInitCommand).command(yargsIdentityDeletionCancelCommand);
+        },
+        handler: () => {
+            yargs.showHelp("log");
+        }
+    })
     .command(startConnectorCommand)
     .demandCommand(1, 1, "Please specify a command")
     .scriptName("")

test/modules/cli/identity/identityStatus.test.ts

@@ -0,0 +1,37 @@
+import { sleep } from "@js-soft/ts-utils";
+import { identityDeletionInitHandler, identityStatusHandler } from "../../../../dist/cli/commands";
+import { resetDB, setupEnvironment } from "../setup";
+
+describe("identity status", () => {
+    const identityStatusPattern = /Id: did:e:((([A-Za-z0-9]+(-[A-Za-z0-9]+)*)\.)+[a-z]{2,}|localhost):dids:[0-9a-f]{22}/;
+    beforeAll(() => {
+        setupEnvironment();
+    });
+
+    afterAll(async () => {
+        await resetDB();
+    });
+
+    afterEach(() => {
+        jest.resetAllMocks();
+    });
+
+    test("show identity status", async () => {
+        const consoleSpy = jest.spyOn(console, "log");
+        await identityStatusHandler({});
+        expect(consoleSpy).toHaveBeenCalledTimes(1);
+        expect(consoleSpy.mock.lastCall![0]).toMatch(identityStatusPattern);
+
+        await identityDeletionInitHandler({});
+        await sleep(1000);
+        expect(consoleSpy).toHaveBeenCalledWith("Identity deletion initiated");
+        expect(consoleSpy).toHaveBeenCalledTimes(2);
+
+        await identityStatusHandler({});
+        expect(consoleSpy).toHaveBeenCalledTimes(3);
+        expect(consoleSpy.mock.lastCall![0]).toMatch(identityStatusPattern);
+        expect(consoleSpy.mock.lastCall![0]).toContain("Identity deletion status: Approved");
+        expect(consoleSpy.mock.lastCall![0]).toMatch(/End of approval period:/);
+        expect(consoleSpy.mock.lastCall![0]).toMatch(/End of grace period:/);
+    });
+});

test/modules/cli/identityDeletion/identityDeletion.test.ts

@@ -0,0 +1,30 @@
+import { identityDeletionCancelHandler, identityDeletionInitHandler } from "../../../../dist/cli/commands";
+import { resetDB, setupEnvironment } from "../setup";
+
+describe("identity deletion", () => {
+    beforeAll(() => {
+        setupEnvironment();
+    });
+
+    afterAll(async () => {
+        await resetDB();
+    });
+
+    beforeEach(() => {
+        jest.resetAllMocks();
+    });
+
+    test("initiate identity deletion", async () => {
+        const consoleSpy = jest.spyOn(console, "log");
+        await identityDeletionInitHandler({});
+        expect(consoleSpy).toHaveBeenCalledWith("Identity deletion initiated");
+        expect(consoleSpy).toHaveBeenCalledTimes(1);
+    });
+
+    test("cancel identity deletion", async () => {
+        const consoleSpy = jest.spyOn(console, "log");
+        await identityDeletionCancelHandler({});
+        expect(consoleSpy).toHaveBeenCalledWith("Identity deletion canceled");
+        expect(consoleSpy).toHaveBeenCalledTimes(1);
+    });
+});

test/modules/cli/setup.ts

@@ -0,0 +1,26 @@
+import { rm } from "fs/promises";
+import { join } from "path";
+import getPort from "../../lib/getPort";
+
+export function setupEnvironment(): void {
+    process.env.database = JSON.stringify({
+        driver: "lokijs",
+        folder: "./",
+        dbName: `default${process.pid}`,
+        dbNamePrefix: "test-"
+    });
+    process.env.NODE_CONFIG_ENV = "test";
+    process.env.API_KEY = "test";
+    process.env["infrastructure:httpServer:port"] = getPort().toString();
+
+    process.env["transportLibrary:baseUrl"] = process.env["NMSHD_TEST_BASEURL"];
+    process.env["transportLibrary:platformClientId"] = process.env["NMSHD_TEST_CLIENTID"];
+    process.env["transportLibrary:platformClientSecret"] = process.env["NMSHD_TEST_CLIENTSECRET"];
+}
+export async function resetDB(): Promise<void> {
+    try {
+        await rm(join(__dirname, `../../../test-default${process.pid}.db`));
+    } catch (_e) {
+        // Ignore
+    }
+}

tsconfig.json

@@ -3,6 +3,7 @@
         "target": "es2021",
         "module": "commonjs",
         "sourceMap": true,
+        "declarationMap": true,
         "declaration": true,
         "outDir": "dist",
         "strict": true,