Merge pull request #171 from flowcore-io/add-init-new-user-command

feat: add user initialization command for Keycloak with corresponding…

Author: odinellefsen

src/commands/index.ts

@@ -85,6 +85,9 @@ export * from "./security/pat.get.ts"
 export * from "./security/pat.list.ts"
 export * from "./security/permissions.list.ts"
 
+// User
+export * from "./user/user.initialize-in-keycloak.ts"
+
 // Scenario
 export * from "./scenario/scenario.create.ts"
 export * from "./scenario/scenario.delete.ts"

src/commands/user/user.initialize-in-keycloak.ts

@@ -0,0 +1,69 @@
+import { GraphQlCommand } from "../../common/command-graphql.ts"
+import { InvalidResponseException } from "../../exceptions/invalid-response.ts"
+
+/**
+ * The input for initializing user in Keycloak
+ * No input parameters needed - checks current authenticated user
+ */
+export type UserInitializeInKeycloakInput = Record<PropertyKey, never>
+
+/**
+ * The output for initializing user in Keycloak
+ */
+export interface UserInitializeInKeycloakOutput {
+  /** Whether the user is initialized */
+  isInitialized: boolean
+  /** User data if available */
+  me?: unknown
+}
+
+const QUERY = `
+query UserIsInitializedIfDoesNotExist {
+  me
+}
+`
+
+/**
+ * Initialize user in Keycloak - checks if user exists and is initialized
+ */
+export class UserInitializeInKeycloakCommand extends GraphQlCommand<
+  UserInitializeInKeycloakInput,
+  UserInitializeInKeycloakOutput
+> {
+  /**
+   * Get the body for the request
+   */
+  protected override getBody(): Record<string, unknown> {
+    return {
+      query: QUERY,
+      variables: {},
+    }
+  }
+
+  /**
+   * Parse the response
+   */
+  protected override parseResponse(rawResponse: unknown): UserInitializeInKeycloakOutput {
+    const response = rawResponse as {
+      data?: {
+        me?: unknown
+      }
+      errors?: Array<{ message: string }>
+    }
+
+    if (response.errors && response.errors.length > 0) {
+      throw new InvalidResponseException(
+        response.errors.map((e) => e.message).join(", "),
+        { graphql: response.errors.map((e) => e.message).join(", ") },
+      )
+    }
+
+    // If me exists and is not null i.e. flowcore_user_id is not null, user is initialized
+    const isInitialized = response.data?.me !== null && response.data?.me !== undefined
+
+    return {
+      isInitialized,
+      me: response.data?.me,
+    }
+  }
+}

test/tests/commands/user.test.ts

@@ -0,0 +1,97 @@
+import { assertEquals } from "@std/assert"
+import { afterAll, afterEach, describe, it } from "@std/testing/bdd"
+import { FlowcoreClient, UserInitializeInKeycloakCommand } from "../../../src/mod.ts"
+import { FetchMocker } from "../../fixtures/fetch.fixture.ts"
+
+describe("User", () => {
+  const fetchMocker = new FetchMocker()
+  const flowcoreClient = new FlowcoreClient({ getBearerToken: () => "BEARER_TOKEN" })
+  const fetchMockerBuilder = fetchMocker.mock("https://graph.api.flowcore.io")
+
+  afterEach(() => {
+    fetchMocker.assert()
+  })
+  afterAll(() => {
+    fetchMocker.restore()
+  })
+
+  describe("UserInitializeInKeycloakCommand", () => {
+    it("should return initialized true when user exists", async () => {
+      // arrange
+      const userData = { id: "user123", email: "[email protected]" }
+
+      fetchMockerBuilder.post("/graphql")
+        .matchBody({
+          query: `
+query UserIsInitializedIfDoesNotExist {
+  me
+}
+`,
+          variables: {},
+        })
+        .respondWith(200, {
+          data: {
+            me: userData,
+          },
+        })
+
+      // act
+      const command = new UserInitializeInKeycloakCommand({})
+      const response = await flowcoreClient.execute(command)
+
+      // assert
+      assertEquals(response.isInitialized, true)
+      assertEquals(response.me, userData)
+    })
+
+    it("should return initialized false when user does not exist", async () => {
+      // arrange
+      fetchMockerBuilder.post("/graphql")
+        .matchBody({
+          query: `
+query UserIsInitializedIfDoesNotExist {
+  me
+}
+`,
+          variables: {},
+        })
+        .respondWith(200, {
+          data: {
+            me: null,
+          },
+        })
+
+      // act
+      const command = new UserInitializeInKeycloakCommand({})
+      const response = await flowcoreClient.execute(command)
+
+      // assert
+      assertEquals(response.isInitialized, false)
+      assertEquals(response.me, null)
+    })
+
+    it("should handle undefined me response", async () => {
+      // arrange
+      fetchMockerBuilder.post("/graphql")
+        .matchBody({
+          query: `
+query UserIsInitializedIfDoesNotExist {
+  me
+}
+`,
+          variables: {},
+        })
+        .respondWith(200, {
+          data: {},
+        })
+
+      // act
+      const command = new UserInitializeInKeycloakCommand({})
+      const response = await flowcoreClient.execute(command)
+
+      // assert
+      assertEquals(response.isInitialized, false)
+      assertEquals(response.me, undefined)
+    })
+  })
+})