added checkStatus method and its unit test to the RecordScanner object

Author: alexpitsikoulis

sdk/src/models/record-scanner/registrationResponse.ts

@@ -1,5 +1,5 @@
 /**
- * RegistrationResponse is a type that represents a response from a record scanning service.
+ * RegistrationResponse is a type that represents a response from a record scanning service's registration endpoint.
  * 
  * @example
  * const registrationResponse: RegistrationResponse = {

sdk/src/models/record-scanner/statusResponse.ts

@@ -0,0 +1,13 @@
+/**
+ * StatusResponse is a type that represents a response from a record scanning service's status endpoint.
+ * 
+ * @example
+ * const statusResponse: StatusResponse = {
+ *     synced: true,
+ *     percentage: 100,
+ * }
+ */
+export interface StatusResponse {
+    synced: boolean;
+    percentage: number;
+}

sdk/src/record-scanner.ts

@@ -9,6 +9,7 @@ import { RecordsFilter } from "./models/record-scanner/recordsFilter";
 import { RecordsResponseFilter } from "./models/record-scanner/recordsResponseFilter";
 import { RegistrationRequest } from "./models/record-scanner/registrationRequest";
 import { RegistrationResponse } from "./models/record-scanner/registrationResponse";
+import { StatusResponse } from "./models/record-scanner/statusResponse";
 
 type RecordScannerOptions = {
     url: string;
@@ -192,6 +193,29 @@ class RecordScanner implements RecordProvider {
         }
     }
 
+    /**
+     * Check the status of a record scanner indexing job.
+     * 
+     * @param {string} jobId The job id to check.
+     * @returns {Promise<StatusResponse>} The status of the job.
+     */
+    async checkStatus(jobId: string): Promise<StatusResponse> {
+        try {
+            const response = await this.request(
+                new Request(`${this.url}/status/${jobId}`, {
+                    method: "POST",
+                    headers: { "Content-Type": "application/json" },
+                    body: JSON.stringify(jobId),
+                }),
+            );
+
+            return await response.json();
+        } catch (error) {
+            console.error(`Failed to check status of job: ${error}`);
+            throw error;
+        }
+    }
+
     /**
      * Find a record in the record scanner service.
      * 

sdk/tests/record-scanner.test.ts

@@ -347,6 +347,26 @@ describe("RecordScanner", () => {
         expect(request.headers.get("Content-Type")).to.equal("application/json");
     });
 
+    it("should return StatusResponse after successfully checking status", async () => {
+        recordScanner = new RecordScanner({ url: "https://record-scanner.aleo.org", account: defaultAccount });
+        const mockResponse = {
+            ok: true,
+            status: 200,
+            text: () => Promise.resolve(JSON.stringify({ synced: true, percentage: 100 })),
+            json: () => Promise.resolve({ synced: true, percentage: 100 }),
+        };
+        fetchStub.resolves(mockResponse);
+        const statusResponse = await recordScanner.checkStatus("test-job-id");
+        expect(statusResponse).to.deep.equal({ synced: true, percentage: 100 });
+
+        const request = fetchStub.firstCall.args[0] as Request;
+        const body = await request.text();
+        const expectedBody = JSON.stringify("test-job-id");
+        expect(body).to.equal(expectedBody);
+        expect(request.method).to.equal("POST");
+        expect(request.headers.get("Content-Type")).to.equal("application/json");
+    });
+
     it("should handle HTTP errors", async () => {
         recordScanner = new RecordScanner({ url: "https://record-scanner.aleo.org", account: defaultAccount });
         let mockResponse = {