fix tests, dev command, cleanup

acao · acao · commit 20f30065d953 · 2025-01-14T03:31:56.000-05:00
diff --git a/.babelrc b/.babelrc
diff --git a/.flowconfig b/.flowconfig
diff --git a/.travis.yml b/.travis.yml
diff --git a/LICENSE b/LICENSE
diff --git a/netlify.toml b/netlify.toml
@@ -2,11 +2,10 @@
   functions = "handler"
   command = "npm run download && npm run build"
   publish = "public/"
-
-[watch]
-  functions = "handler"
+[dev]
   command = "npm run download && npm run build"
   publish = "public/"
+  functions = "handler"
 [[headers]]
   for = "/*"
   [headers.values]
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -20,15 +20,16 @@
   "type": "module",
   "scripts": {
     "postinstall": "npm run download && npm run build",
-    "watch": "netlify dev",
+    "dev": "npm run download && netlify dev -c 'tsc --watch'",
     "start": "netlify build",
     "test": "npm run lint && npm run check && npm run test:only",
-    "test:only": "vitest run --config ./vitest.config.ts",
+    "test:only": "vitest run",
     "lint": "eslint src/** handler/**",
     "lint:fix": "eslint --fix src handler/**",
     "check": "tsc --noEmit",
-    "build": "rimraf lib && tsc ",
-    "download": "node scripts/download.js cache/data.json",
+    "build": "rimraf lib && tsc",
+    "build:watch": "tsc --watch",
+    "download": "node scripts/download.mjs cache/data.json",
     "serve-public": "node scripts/serve-public",
     "prettier": "prettier --write 'src/**/*.js'",
     "print-schema": "node scripts/print-schema.js",
@@ -54,7 +55,7 @@
     "typescript": "^5.1.6",
     "vitest": "^0.34.1"
   },
-  "resolutions": {
+  "overrides": {
     "graphql": "^16.7.1"
   }
 }
diff --git a/scripts/download.mjs b/scripts/download.mjs
@@ -10,7 +10,7 @@ import { URL } from 'url';
 import { Agent } from 'https';
 import { existsSync, writeFileSync } from 'fs';
 import fetch from 'isomorphic-fetch';
-import { swapiPath } from '../src/schema/constants';
+import { swapiPath } from '../src/schema/constants.mjs';
 
 const resources = [
   'people',
diff --git a/src/api/local.ts b/src/api/local.ts
@@ -8,7 +8,7 @@
 
  */
 
-import { DataResult } from '../types.js';
+import { DataResult, ResultItem } from '../types.js';
 
 
 /**
@@ -21,13 +21,13 @@ export async function getFromLocalUrl(
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
   const swapiData = (await import('../../cache/data.json')).default
-  const text = swapiData[url] as DataResult;
+  const text = swapiData[url] as ResultItem;
   if (!text) {
     throw new Error(`No entry in local cache for ${url}`);
   }
   if (process.env.NODE_ENV !== 'test') {
     // eslint-disable-next-line no-console
     console.log(`Hit the local cache for ${url}.`);
   }
-  return text as DataResult;
+  return text as ResultItem;
 }
diff --git a/src/schema/__tests__/schema.spec.ts b/src/schema/__tests__/schema.spec.ts
@@ -12,18 +12,18 @@ import { swapi } from './swapi';
 describe('Schema', () => {
   it('Gets an error when ID is omitted', async () => {
     const query = '{ species { name } }';
-    const result = await swapi(query);
+    const result = await swapi(query, false);
     expect(result.errors.length).toBe(1);
     expect(result.errors[0].message).toBe('must provide id or speciesID');
     expect(result.data).toMatchObject({ species: null });
   });
 
   it('Gets an error when global ID is invalid', async () => {
     const query = '{ species(id: "notanid") { name } }';
-    const result = await swapi(query);
+    const result = await swapi(query, false);
     expect(result.errors.length).toBe(1);
     expect(result.errors[0].message).toEqual(
-      expect.stringContaining('No entry in local cache for'),
+      expect.stringContaining('No valid ID extracted from notanid'),
     );
     expect(result.data).toMatchObject({ species: null });
   });
diff --git a/src/schema/__tests__/species.spec.ts b/src/schema/__tests__/species.spec.ts
@@ -22,8 +22,8 @@ function getDocument(query) {
       language
       name
       skinColors
-      filmConnection(first:1) { edges { node { title } } }
-      personConnection(first:1) { edges { node { name } } }
+      filmConnection(first: 1) { edges { node { title } } }
+      personConnection(first: 1) { edges { node { name } } }
     }
   `;
 }
diff --git a/src/schema/__tests__/swapi.ts b/src/schema/__tests__/swapi.ts
@@ -5,15 +5,15 @@
  * This source code is licensed under the license found in the
  * LICENSE-examples file in the root directory of this source tree.
  */
-import  { execute, parse } from 'graphql';
+import { execute, parse } from 'graphql';
 import swapiSchema from '../index';
 
-export async function swapi(query: string) {
+export async function swapi(query: string, throwErrors: boolean = true) {
   const result = await execute({
     schema: swapiSchema,
-    document: parse(query)
+    document: parse(query),
   });
-  if (result.errors !== undefined) {
+  if (result.errors !== undefined && throwErrors) {
     throw new Error(JSON.stringify(result.errors, null, 2));
   }
   return result!;
diff --git a/src/schema/apiHelper.ts b/src/schema/apiHelper.ts
@@ -10,9 +10,9 @@
 
 import DataLoader from 'dataloader';
 
-import { swapiPath } from './constants.js';
+import { swapiPath } from './constants.mjs';
 import { getFromLocalUrl } from '../api/index.js';
-import { DataResult, ObjectWithId, endPoints } from '../types.js';
+import { DataResult, ObjectWithId, endPoints, ResultItem, NormalResultItem } from '../types.js';
 
 
 const localUrlLoader = new DataLoader((urls: readonly string[]) =>
@@ -22,7 +22,8 @@ const localUrlLoader = new DataLoader((urls: readonly string[]) =>
 /**
  * Objects returned from SWAPI don't have an ID field, so add one.
  */
-function objectWithId(obj: DataResult): ObjectWithId {
+function objectWithId(obj: NormalResultItem): ObjectWithId {
+  // @ts-expect-error 
   return { 
     ...obj,
     id: parseInt(obj.url.split('/')[5], 10)
@@ -34,8 +35,11 @@ function objectWithId(obj: DataResult): ObjectWithId {
  */
 export async function getObjectFromUrl(url: string): Promise<ObjectWithId> {
   const data = await localUrlLoader.load(url);
-  // some objects have a 'properties' field, others simply have the data
-  return objectWithId(data.properties || data);
+    // some objects have a 'properties' field, others simply have the data
+  if('properties' in data && data.properties) {
+    return objectWithId(data.properties);
+  }
+  return objectWithId(data as NormalResultItem);
 }
 
 /**
@@ -62,7 +66,9 @@ export async function getObjectsByType(type: string): Promise<ObjectsByType> {
   let nextUrl = `${swapiPath}/${type}`;
   while (nextUrl) {
     // eslint-disable-next-line no-await-in-loop
+    // @ts-expect-error 
     const pageData = await localUrlLoader.load(nextUrl) as DataResult;
+    // @ts-expect-error
     const results = pageData.result || pageData.results || [];
     objects = objects.concat(results.map(item => objectWithId(item.properties || item)));
     nextUrl = pageData.next as string;
@@ -84,10 +90,12 @@ function sortObjectsById(array: ObjectWithId[]): ObjectWithId[] {
  * Given a string, convert it to a number
  */
 export function convertToNumber(value: string): number | null {
-  if (['unknown', 'n/a'].indexOf(value) !== -1) {
+  if (['unknown', 'indefinite', 'n/a'].indexOf(value) !== -1) {
     return null;
   }
+  // if none, it's 0
+  if(value === 'none') return 0;
   // remove digit grouping
-  const numberString = value.replace(/,/, '');
+  const numberString = value.replace(/,/, '').replace('km', '');
   return Number(numberString);
 }
diff --git a/src/schema/connections.ts b/src/schema/connections.ts
@@ -16,9 +16,7 @@ import {
 
 import { getObjectsFromUrls } from './apiHelper.js';
 
-import { GraphQLInt, GraphQLList } from 'graphql';
-
-import type { GraphQLObjectType } from 'graphql';
+import { GraphQLInt, GraphQLList,  type GraphQLObjectType  } from 'graphql';
 
 /**
  * Constructs a GraphQL connection field config; it is assumed
diff --git a/src/schema/constants.mjs b/src/schema/constants.mjs
diff --git a/src/schema/index.ts b/src/schema/index.ts
@@ -136,7 +136,5 @@ const rootType = new GraphQLObjectType({
   }),
 });
 
-export { parse, execute } from 'graphql';
-
 export default new GraphQLSchema({ query: rootType });
 
diff --git a/src/schema/relayNode.ts b/src/schema/relayNode.ts
@@ -30,8 +30,6 @@ import { endPoints } from '../types.js';
  * Given a "type" in SWAPI, returns the corresponding GraphQL type.
  */
 export function swapiTypeToGraphQLType(swapiType: endPoints) {
-
-
   switch (swapiType) {
     case 'films':
       return FilmType;
@@ -55,10 +53,9 @@ const { nodeInterface, nodeField } = nodeDefinitions<unknown>(
     const { type, id } = fromGlobalId(globalId);
     return getObjectFromTypeAndId(type as endPoints, id);
   },
-  // @ts-expect-error not sure what to do here
  (obj) => {
     const parts = obj.url.split('/');
-    return swapiTypeToGraphQLType(parts[parts.length - 3]);
+    return swapiTypeToGraphQLType(parts[parts.length - 3]).name;
   },
 );
 
diff --git a/src/schema/types/person.ts b/src/schema/types/person.ts
@@ -29,7 +29,7 @@ import StarshipType from './starship.js';
 import VehicleType from './vehicle.js';
 
 
-type Person = {
+export type Person = {
   name: string,
   birth_year: string,
   eye_color: string,
diff --git a/src/types.ts b/src/types.ts
@@ -1,8 +1,18 @@
-export type ObjectWithId = DataResult & {
-    id: number,
-};
+import { Film } from "./schema/types/film.js";
+import { Person } from "./schema/types/person.js";
+import { Planet } from "./schema/types/planet.js";
+import { Species } from "./schema/types/species.js";
+import { Starship } from "./schema/types/starship.js";
+import { Vehicle } from "./schema/types/vehicle.js";
+
+
+
 
-export type ResultItem = { next: string | null, url: string, [key: string]: unknown } | { properites: { next: string | null, url: string, [key: string]: unknown } }
+export type SwapiObject = Film | Person | Planet | Species | Starship | Vehicle
+
+export type NormalResultItem = { next: string | null, url: string } & SwapiObject
+
+export type ResultItem = NormalResultItem  | { properties: NormalResultItem }
 
 export type DataResult = {
     url: string,
@@ -14,6 +24,9 @@ export type DataResult = {
     next: string | null,
 }
 
+export type ObjectWithId = DataResult & {
+    id: number,
+};
 
 export type endPoints = 'people' | 'films' | 'planets' | 'species' | 'starships' | 'vehicles'
 
diff --git a/tsconfig.json b/tsconfig.json
@@ -11,6 +11,6 @@
         "rootDir": "src",
         "checkJs": false
     },
-    "include": ["src/**/*.ts"],
+    "include": ["src/**/*.ts", "src/schema/constants.mjs"],
     "exclude": ["node_modules", "**/*.test.ts", "public", "handler", "**/__tests__/**", "**/__tests__/**/*.spec.ts"]
 }
diff --git a/vitest.config.ts b/vitest.config.ts
@@ -2,14 +2,9 @@ import { defineConfig } from 'vitest/config';
 import path from 'path';
 
 export default defineConfig({
-  legacy: {
-    alias: {
-        graphql: path.resolve(__dirname, 'node_modules/graphql'),
-      },
-  },
   test: {
     alias: {
-      graphql: path.resolve(__dirname, 'node_modules/graphql'),
+      graphql: path.resolve(__dirname, 'node_modules/graphql/index.js'),
     },
     // ... Other options
   },
