feat(TS): Changed tests to TypeScript and updated typings (#136)

* Changed tests to TypeScript and updated typings. * fix: review changes
ftrackhq · Sep 11, 2023 · 8879010 · 8879010
1 parent b1c1bac
commit 8879010
Show file tree

Hide file tree

Showing 12 changed files with 106 additions and 55 deletions.
diff --git a/source/operation.ts b/source/operation.ts
@@ -35,14 +35,14 @@ export interface SearchOperation {
 export interface UpdateOperation {
   action: "update";
   entity_type: string;
-  entity_key: string[];
+  entity_key: string[] | string;
   entity_data: any;
 }
 
 export interface DeleteOperation {
   action: "delete";
   entity_type: string;
-  entity_key: string[];
+  entity_key: string[] | string;
 }
 
 export interface QueryServerInformationOperation {
@@ -138,7 +138,7 @@ export function search({
  */
 export function update(
   type: string,
-  keys: string[],
+  keys: string[] | string,
   data: any
 ): UpdateOperation {
   return {
@@ -158,7 +158,10 @@ export function update(
  * @param  {Array} keys Identifying keys, typically [<entity id>]
  * @return {Object}      API operation
  */
-function deleteOperation(type: string, keys: string[]): DeleteOperation {
+function deleteOperation(
+  type: string,
+  keys: string[] | string
+): DeleteOperation {
   return {
     action: "delete",
     entity_type: type,

diff --git a/source/session.ts b/source/session.ts
@@ -19,6 +19,7 @@ import type {
   CreateResponse,
   Data,
   DeleteResponse,
+  Entity,
   GetUploadMetadataResponse,
   IsTuple,
   MutationOptions,
@@ -669,7 +670,7 @@ export class Session {
     entityType: string,
     data: T,
     identifyingKeys: Array<keyof T> = []
-  ): Promise<T> {
+  ): Promise<T & Entity> {
     let keys = identifyingKeys as string[];
 
     logger.info(
@@ -712,7 +713,7 @@ export class Session {
 
     expression = `${expression} ${criteria.join(" and ")}`;
 
-    return this.query<T>(expression).then((response) => {
+    return this.query<T & Entity>(expression).then((response) => {
       if (response.data.length === 0) {
         return this.create<T>(entityType, data).then(({ data: responseData }) =>
           Promise.resolve(responseData)
@@ -731,7 +732,7 @@ export class Session {
 
       // Update entity if required.
       let updated = false;
-      Object.keys(data).forEach((key: keyof T) => {
+      Object.keys(data).forEach((key: keyof (T & Entity)) => {
         if (data[key] !== updateEntity[key]) {
           updateEntity[key] = data[key];
           updated = true;
@@ -748,7 +749,9 @@ export class Session {
             }
             return accumulator;
           }, {} as T)
-        ).then(({ data: responseData }) => Promise.resolve(responseData));
+        ).then(({ data: responseData }) =>
+          Promise.resolve(responseData as T & Entity)
+        );
       }
 
       return Promise.resolve(response.data[0]);
@@ -858,7 +861,7 @@ export class Session {
   ) {
     logger.debug("Create", entityType, data, options);
 
-    const responses = await this.call<[CreateResponse<T>]>(
+    const responses = await this.call<[CreateResponse<T & Entity>]>(
       [operation.create(entityType, data)],
       options
     );
@@ -879,7 +882,7 @@ export class Session {
    */
   async update<T extends Data = Data>(
     type: string,
-    keys: string[],
+    keys: string[] | string,
     data: T,
     options: MutationOptions = {}
   ) {
@@ -903,7 +906,11 @@ export class Session {
    * @param {object} options.decodeDatesAsIso - Decode dates as ISO strings instead of moment objects
    * @return {Promise} Promise resolved with the response.
    */
-  async delete(type: string, keys: string[], options: MutationOptions = {}) {
+  async delete(
+    type: string,
+    keys: string[] | string,
+    options: MutationOptions = {}
+  ) {
     logger.debug("Delete", type, keys, options);
 
     const responses = await this.call<[DeleteResponse]>(

diff --git a/source/util/convert_to_iso_string.ts b/source/util/convert_to_iso_string.ts
@@ -1,3 +1,6 @@
+import { Moment } from "moment";
+import type dayjs from "dayjs";
+
 /**
  * Checks if string is in ISO 6801 format.
  */
@@ -14,7 +17,9 @@ function isIsoDate(str: string) {
  * @param data - string or date object
  * @returns ISO 6801 compatible string, or null if invalid date
  */
-export function convertToIsoString(data: string | Date) {
+export function convertToIsoString(
+  data: string | Date | Moment | ReturnType<typeof dayjs>
+) {
   if (
     data &&
     // if this is a date object of type moment or dayjs, or regular date object (all of them has toISOString)
@@ -24,7 +29,7 @@ export function convertToIsoString(data: string | Date) {
   ) {
     // wrap it new Date() to convert it to UTC based ISO string in case it is in another timezone
     try {
-      return new Date(data).toISOString();
+      return new Date(data as any).toISOString();
     } catch (err) {
       return null;
     }

diff --git a/test/back_off.test.js → test/back_off.test.ts b/test/back_off.test.js → test/back_off.test.ts
@@ -1,6 +1,6 @@
 // :copyright: Copyright (c) 2023 ftrack
 import { backOff } from "../source/util/back_off";
-import { expect } from "vitest";
+import { describe, it, expect } from "vitest";
 
 describe("backOff", () => {
   it("should return the result of the successful request", async () => {

diff --git a/test/convert_to_iso_string.test.js → test/convert_to_iso_string.test.ts b/test/convert_to_iso_string.test.js → test/convert_to_iso_string.test.ts
@@ -3,6 +3,7 @@
 import { convertToIsoString } from "../source/util/convert_to_iso_string";
 import moment from "moment";
 import dayjs from "dayjs";
+import { describe, it, expect } from "vitest";
 
 describe("convertToIsoString", () => {
   it("should convert date object to ISO", () => {
@@ -55,7 +56,7 @@ describe("convertToIsoString", () => {
     new Date("hello world"),
     NaN,
   ])("should return null for invalid ISO string: %s", (invalidDate) => {
-    const converted = convertToIsoString(invalidDate);
+    const converted = convertToIsoString(invalidDate as any); //casted to test for invalid type
     expect(converted).toEqual(null);
   });
 });
diff --git a/test/event_hub.test.js → test/event_hub.test.ts b/test/event_hub.test.js → test/event_hub.test.ts
@@ -1,6 +1,7 @@
 import { EventHub } from "../source/event_hub";
-import { vi, describe, expect } from "vitest";
 import { Event } from "../source/event";
+import { vi, describe, expect, beforeEach, afterEach, test } from "vitest";
+
 describe("EventHub", () => {
   let eventHub;
 

diff --git a/test/get_chunk_size.test.js → test/get_chunk_size.test.ts b/test/get_chunk_size.test.js → test/get_chunk_size.test.ts
@@ -1,5 +1,6 @@
 // :copyright: Copyright (c) 2023 ftrack
 import { getChunkSize } from "../source/util/get_chunk_size";
+import { describe, expect, it } from "vitest";
 
 describe("getChunkSize", () => {
   it("should return the correct chunk size for a given file size", () => {

diff --git a/test/normalize_string.test.js → test/normalize_string.test.ts b/test/normalize_string.test.js → test/normalize_string.test.ts
@@ -1,5 +1,6 @@
 // :copyright: Copyright (c) 2019 ftrack
 import normalizeString from "../source/util/normalize_string";
+import { describe, it, expect } from "vitest";
 
 describe("Normalize string", () => {
   it("should normalize COMBINING DIAERESIS", () => {

diff --git a/test/server.js → test/server.ts b/test/server.js → test/server.ts
@@ -46,7 +46,9 @@ export const handlers = [
       );
     }
     const body = await Promise.all(
-      req.body.map(
+      (
+        await req.json()
+      ).map(
         async ({
           action,
           expression,