Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/haydn/use-record-set. A React hook for quickly prototyping data models. 09qzj.csb.app
data graphql prototyping
Something went wrong. Try again.
use-record-set test.ts
59 kB · 2440 lines
TypeScript
at main
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441import { act, renderHook } from "@testing-library/react";import { spawnSync } from "child_process";import dedent from "dedent";import { mkdtempSync, readFileSync, rmSync, writeFileSync } from "fs";import { execute, printSchema } from "graphql";import gql from "graphql-tag";import { fromBase64, toBase64 } from "js-base64";import { tmpdir } from "os";import { join } from "path";import { BooleanField, DateField, ForeignKeyField, InverseField, LocalStoragePersistence, NumberField, RecordSet, Schema, StringField, TypedDocumentNode, UrlPersistence, createRecordSet, printRecordSetSchema,} from "./index.js";
const nodeOnlyTest = typeof window === "object" ? test.skip : test;const browserOnlyTest = typeof window === "object" ? test : test.skip;
const MINIMAL_SCHEMA: Schema = { Record: { meta: { singular: "record", plural: "records", }, fields: {}, },};
const SCALAR_FIELDS_SCHEMA: Schema = { Record: { meta: { singular: "record", plural: "records", }, fields: { string: { type: "String", }, number: { type: "Number", }, boolean: { type: "Boolean", }, date: { type: "Date", }, }, },};
const FOREIGN_KEYS_SCHEMA: Schema = { Record: { meta: { singular: "record", plural: "records", }, fields: { manyToMany: { type: "ForeignKey", cardinality: "manyToMany", }, manyToOne: { type: "ForeignKey", cardinality: "manyToOne", }, oneToOne: { type: "ForeignKey", cardinality: "oneToOne", }, oneToMany: { type: "ForeignKey", cardinality: "oneToMany", }, }, },};
const INVERSE_RELATIONS_SCHEMA: Schema = { Record: { meta: { singular: "record", plural: "records", }, fields: { manyToMany: { type: "ForeignKey", cardinality: "manyToMany", }, manyToOne: { type: "ForeignKey", cardinality: "manyToOne", }, oneToOne: { type: "ForeignKey", cardinality: "oneToOne", }, oneToMany: { type: "ForeignKey", cardinality: "oneToMany", }, inverseManyToMany: { type: "Inverse", source: { type: "Record", field: "manyToMany", }, }, inverseManyToOne: { type: "Inverse", source: { type: "Record", field: "manyToOne", }, }, inverseOneToOne: { type: "Inverse", source: { type: "Record", field: "oneToOne", }, }, inverseOneToMany: { type: "Inverse", source: { type: "Record", field: "oneToMany", }, }, inverseMultiple: { type: "Inverse", source: [ { type: "Record", field: "manyToMany", }, { type: "Record", field: "manyToOne", }, { type: "Record", field: "oneToOne", }, { type: "Record", field: "oneToMany", }, ], }, }, },};
const COMPLEX_SCHEMA: Schema = { Role: { meta: { singular: "role", plural: "roles", }, fields: { lineManager: { type: "ForeignKey", cardinality: "manyToOne", }, responsibilities: { type: "ForeignKey", cardinality: "oneToMany", }, holder: { type: "ForeignKey", cardinality: "oneToOne", }, teams: { type: "ForeignKey", cardinality: "manyToMany", }, reports: { type: "Inverse", source: { type: "Role", field: "lineManager", }, }, }, }, Responsibility: { meta: { singular: "responsibility", plural: "responsibilities", }, fields: { owner: { type: "Inverse", source: { type: "Role", field: "responsibilities", }, }, }, }, Person: { meta: { singular: "person", plural: "people", }, fields: { role: { type: "Inverse", source: { type: "Role", field: "holder", }, }, }, }, Team: { meta: { singular: "team", plural: "teams", }, fields: { members: { type: "Inverse", source: { type: "Role", field: "teams", }, }, }, },};
describe("RecordSet initialization", () => { test("no schema", () => { expect(() => { new RecordSet({}); }).not.toThrow(); });
test("minimal schema", () => { expect(() => { new RecordSet(MINIMAL_SCHEMA); }).not.toThrow(); });
describe("config", () => { test("minimal init", () => { expect(() => { new RecordSet( {}, { init: [], }, ); }).not.toThrow(); });
test.skip("init with record not in schema", () => { expect(() => { new RecordSet( {}, { init: [{ type: "Record", id: "87c22bff-926f-4005-a359-69bb996eab1f" }], }, ); }).toThrow(); });
test.skip("init with record missing type", () => { expect(() => { new RecordSet(MINIMAL_SCHEMA, { init: [{ id: "87c22bff-926f-4005-a359-69bb996eab1f" } as any], }); }).toThrow(); });
test.skip("init with record missing id", () => { expect(() => { new RecordSet(MINIMAL_SCHEMA, { init: [{ type: "Record" } as any], }); }).toThrow(); }); });});
describe("RecordSet schema generation", () => { test("no schema", () => { const recordSet = new RecordSet({}); expect(printSchema(recordSet.schema).trim()).toBe( dedent` schema { query: RootQueryType mutation: RootMutationType }
type RootQueryType { relationships(foreignKeys: [ForeignKeyInput]): [Relationship] }
type Relationship { source: Node target: Node }
interface Node { id: String! }
input ForeignKeyInput { type: String! field: String! }
type RootMutationType { addRelationship(field: String!, source: String!, target: String!): Node removeRelationship(field: String!, source: String!, target: String!): Node } `.trim(), ); });
test("minimal schema", () => { const recordSet = new RecordSet(MINIMAL_SCHEMA); expect(printSchema(recordSet.schema).trim()).toBe( dedent` schema { query: RootQueryType mutation: RootMutationType }
type RootQueryType { relationships(foreignKeys: [ForeignKeyInput]): [Relationship] record(id: String!): Record records(ids: [String!]): [Record]! }
type Relationship { source: Node target: Node }
interface Node { id: String! }
input ForeignKeyInput { type: String! field: String! }
type Record implements Node { id: String! }
type RootMutationType { addRelationship(field: String!, source: String!, target: String!): Node removeRelationship(field: String!, source: String!, target: String!): Node createRecord(id: String): Record updateRecord(id: String!): Record deleteRecord(id: String!): Record } `.trim(), ); });
test("scalar fields", () => { const recordSet = new RecordSet(SCALAR_FIELDS_SCHEMA); expect(printSchema(recordSet.schema).trim()).toBe( dedent` schema { query: RootQueryType mutation: RootMutationType }
type RootQueryType { relationships(foreignKeys: [ForeignKeyInput]): [Relationship] record(id: String!): Record records(ids: [String!]): [Record]! }
type Relationship { source: Node target: Node }
interface Node { id: String! }
input ForeignKeyInput { type: String! field: String! }
type Record implements Node { id: String! string: String number: Float boolean: Boolean date: String }
type RootMutationType { addRelationship(field: String!, source: String!, target: String!): Node removeRelationship(field: String!, source: String!, target: String!): Node createRecord(id: String, string: String, number: Float, boolean: Boolean, date: String): Record updateRecord(id: String!, string: String, number: Float, boolean: Boolean, date: String): Record deleteRecord(id: String!): Record } `.trim(), ); });
test("foreign keys", () => { const recordSet = new RecordSet(FOREIGN_KEYS_SCHEMA); expect(printSchema(recordSet.schema).trim()).toBe( dedent` schema { query: RootQueryType mutation: RootMutationType }
type RootQueryType { relationships(foreignKeys: [ForeignKeyInput]): [Relationship] record(id: String!): Record records(ids: [String!]): [Record]! }
type Relationship { source: Node target: Node }
interface Node { id: String! }
input ForeignKeyInput { type: String! field: String! }
type Record implements Node { id: String! manyToMany: [Node!]! manyToOne: Node oneToOne: Node oneToMany: [Node!]! }
type RootMutationType { addRelationship(field: String!, source: String!, target: String!): Node removeRelationship(field: String!, source: String!, target: String!): Node createRecord(id: String): Record updateRecord(id: String!): Record deleteRecord(id: String!): Record } `.trim(), ); });
test("inverse relations", () => { const recordSet = new RecordSet(INVERSE_RELATIONS_SCHEMA); expect(printSchema(recordSet.schema).trim()).toBe( dedent` schema { query: RootQueryType mutation: RootMutationType }
type RootQueryType { relationships(foreignKeys: [ForeignKeyInput]): [Relationship] record(id: String!): Record records(ids: [String!]): [Record]! }
type Relationship { source: Node target: Node }
interface Node { id: String! }
input ForeignKeyInput { type: String! field: String! }
type Record implements Node { id: String! manyToMany: [Node!]! manyToOne: Node oneToOne: Node oneToMany: [Node!]! inverseManyToMany: [Node!]! inverseManyToOne: [Node!]! inverseOneToOne: Node inverseOneToMany: Node inverseMultiple: [Node!]! }
type RootMutationType { addRelationship(field: String!, source: String!, target: String!): Node removeRelationship(field: String!, source: String!, target: String!): Node createRecord(id: String): Record updateRecord(id: String!): Record deleteRecord(id: String!): Record } `.trim(), ); });
test.skip("complex", () => { const recordSet = new RecordSet(COMPLEX_SCHEMA); expect(printSchema(recordSet.schema).trim()).toBe( dedent` schema { query: RootQueryType mutation: RootMutationType }
type RootQueryType { relationships(foreignKeys: [ForeignKeyInput]): [Relationship] role(id: String!): Role roles(ids: [String!]): [Role]! # TODO }
type Relationship { source: Node target: Node }
interface Node { id: String! }
input ForeignKeyInput { type: String! field: String! }
type Role implements Node { id: String! # TODO }
# TODO
type RootMutationType { addRelationship(field: String!, source: String!, target: String!): Node removeRelationship(field: String!, source: String!, target: String!): Node createRole(id: String): Role updateRole(id: String!): Role deleteRole(id: String!): Role # TODO } `.trim(), ); });});
describe("RecordSet query resolution", () => { test("no schema", () => { const recordSet = new RecordSet({});
expect( execute({ schema: recordSet.schema, document: gql` query { relationships(foreignKeys: []) } `, }), ).toEqual({ data: { relationships: [] } }); });
test("single record", () => { const recordSet = new RecordSet(MINIMAL_SCHEMA, { init: [ { type: "Record", id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", }, ], });
expect( execute({ schema: recordSet.schema, document: gql` query { record(id: "267d5cb0-90aa-471c-b5fc-3b31afd73184") { id } } `, }), ).toEqual({ data: { record: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", }, }, }); });
test("multiple records", () => { const recordSet = new RecordSet(MINIMAL_SCHEMA, { init: [ { type: "Record", id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", }, ], });
expect( execute({ schema: recordSet.schema, document: gql` query { records(ids: ["267d5cb0-90aa-471c-b5fc-3b31afd73184"]) { id } } `, }), ).toEqual({ data: { records: [ { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", }, ], }, }); });
test("all records", () => { const recordSet = new RecordSet(MINIMAL_SCHEMA, { init: [ { type: "Record", id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", }, ], });
expect( execute({ schema: recordSet.schema, document: gql` query { records { id } } `, }), ).toEqual({ data: { records: [ { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", }, ], }, }); });
test("scalar fields", () => { const recordSet = new RecordSet(SCALAR_FIELDS_SCHEMA, { init: [ { type: "Record", id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", string: "hello", number: 1, boolean: true, date: "2021-06-17T19:54:14Z", }, ], });
expect( execute({ schema: recordSet.schema, document: gql` query { record(id: "267d5cb0-90aa-471c-b5fc-3b31afd73184") { id ... on Record { string number boolean date } } } `, }), ).toEqual({ data: { record: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", string: "hello", number: 1, boolean: true, date: "2021-06-17T19:54:14Z", }, }, }); });
test("foreign keys", () => { const recordSet = new RecordSet(FOREIGN_KEYS_SCHEMA, { init: [ { type: "Record", id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", manyToMany: ["267d5cb0-90aa-471c-b5fc-3b31afd73184"], manyToOne: "267d5cb0-90aa-471c-b5fc-3b31afd73184", oneToOne: "267d5cb0-90aa-471c-b5fc-3b31afd73184", oneToMany: ["267d5cb0-90aa-471c-b5fc-3b31afd73184"], }, ], });
expect( execute({ schema: recordSet.schema, document: gql` query { record(id: "267d5cb0-90aa-471c-b5fc-3b31afd73184") { id manyToMany { id } manyToOne { id } oneToOne { id } oneToMany { id } } } `, }), ).toEqual({ data: { record: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", manyToMany: [{ id: "267d5cb0-90aa-471c-b5fc-3b31afd73184" }], manyToOne: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184" }, oneToOne: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184" }, oneToMany: [{ id: "267d5cb0-90aa-471c-b5fc-3b31afd73184" }], }, }, }); });
test("inverse relations", () => { const recordSet = new RecordSet(INVERSE_RELATIONS_SCHEMA, { init: [ { type: "Record", id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", manyToMany: ["71dddd29-680d-4dbd-92ed-2ea085a569cb"], manyToOne: "71dddd29-680d-4dbd-92ed-2ea085a569cb", oneToOne: "71dddd29-680d-4dbd-92ed-2ea085a569cb", oneToMany: ["71dddd29-680d-4dbd-92ed-2ea085a569cb"], }, { type: "Record", id: "71dddd29-680d-4dbd-92ed-2ea085a569cb", manyToMany: [], oneToMany: [], }, ], });
expect( execute({ schema: recordSet.schema, document: gql` query { record(id: "71dddd29-680d-4dbd-92ed-2ea085a569cb") { id inverseManyToMany { id } inverseManyToOne { id } inverseOneToOne { id } inverseOneToMany { id } inverseMultiple { id } } } `, }), ).toEqual({ data: { record: { id: "71dddd29-680d-4dbd-92ed-2ea085a569cb", inverseManyToMany: [{ id: "267d5cb0-90aa-471c-b5fc-3b31afd73184" }], inverseManyToOne: [{ id: "267d5cb0-90aa-471c-b5fc-3b31afd73184" }], inverseOneToOne: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184" }, inverseOneToMany: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184" }, inverseMultiple: [{ id: "267d5cb0-90aa-471c-b5fc-3b31afd73184" }], }, }, }); });
test("complex", () => { const recordSet = new RecordSet(COMPLEX_SCHEMA, { init: [ { type: "Role", id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", lineManager: "668b05fc-7e2a-492b-9ba3-8ee4cedbfdb9", responsibilities: ["bb3c823a-1a2a-4a8a-b650-14a54f595444"], holder: "0fce7933-b729-4c8b-bec5-f3b261e2f5a9", teams: ["1728d91a-001f-421d-90a3-9c8ac337f796"], }, { type: "Role", id: "668b05fc-7e2a-492b-9ba3-8ee4cedbfdb9", }, { type: "Responsibility", id: "bb3c823a-1a2a-4a8a-b650-14a54f595444", }, { type: "Person", id: "0fce7933-b729-4c8b-bec5-f3b261e2f5a9", }, { type: "Team", id: "1728d91a-001f-421d-90a3-9c8ac337f796", }, ], });
expect( execute({ schema: recordSet.schema, document: gql` query { role(id: "267d5cb0-90aa-471c-b5fc-3b31afd73184") { id ... on Role { lineManager { id ... on Role { reports { id } } } responsibilities { id ... on Responsibility { owner { id } } } holder { id ... on Person { role { id } } } teams { id ... on Team { members { id } } } } } } `, }), ).toEqual({ data: { role: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", lineManager: { id: "668b05fc-7e2a-492b-9ba3-8ee4cedbfdb9", reports: [ { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", }, ], }, responsibilities: [ { id: "bb3c823a-1a2a-4a8a-b650-14a54f595444", owner: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", }, }, ], holder: { id: "0fce7933-b729-4c8b-bec5-f3b261e2f5a9", role: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", }, }, teams: [ { id: "1728d91a-001f-421d-90a3-9c8ac337f796", members: [ { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", }, ], }, ], }, }, }); });});
describe("RecordSet mutation resolution", () => { test("minimal schema", () => { const recordSet = new RecordSet(MINIMAL_SCHEMA);
expect( execute({ schema: recordSet.schema, document: gql` mutation { createRecord(id: "267d5cb0-90aa-471c-b5fc-3b31afd73184") { id } } `, }), ).toEqual({ data: { createRecord: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184" } } });
expect( execute({ schema: recordSet.schema, document: gql` query { record(id: "267d5cb0-90aa-471c-b5fc-3b31afd73184") { id } } `, }), ).toEqual({ data: { record: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184" } } });
expect( execute({ schema: recordSet.schema, document: gql` mutation { deleteRecord(id: "267d5cb0-90aa-471c-b5fc-3b31afd73184") { id } } `, }), ).toEqual({ data: { deleteRecord: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184" } } });
expect( execute({ schema: recordSet.schema, document: gql` query { record(id: "267d5cb0-90aa-471c-b5fc-3b31afd73184") { id } } `, }), ).toEqual({ data: { record: null } }); });
test("scalar fields", () => { const recordSet = new RecordSet(SCALAR_FIELDS_SCHEMA, { init: [ { type: "Record", id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", string: "hello", number: 1, boolean: true, date: "2021-06-17T19:54:14Z", }, ], });
expect( execute({ schema: recordSet.schema, document: gql` mutation { updateRecord( id: "267d5cb0-90aa-471c-b5fc-3b31afd73184" string: "world" number: 2 boolean: false date: "2020-07-11T09:43:15Z" ) { id ... on Record { string number boolean date } } } `, }), ).toEqual({ data: { updateRecord: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", string: "world", number: 2, boolean: false, date: "2020-07-11T09:43:15Z", }, }, });
expect( execute({ schema: recordSet.schema, document: gql` query { record(id: "267d5cb0-90aa-471c-b5fc-3b31afd73184") { id ... on Record { string number boolean date } } } `, }), ).toEqual({ data: { record: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", string: "world", number: 2, boolean: false, date: "2020-07-11T09:43:15Z", }, }, }); });
test("addRelationship", () => { const recordSet = new RecordSet(COMPLEX_SCHEMA, { init: [ { type: "Role", id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", }, { type: "Role", id: "668b05fc-7e2a-492b-9ba3-8ee4cedbfdb9", }, { type: "Responsibility", id: "bb3c823a-1a2a-4a8a-b650-14a54f595444", }, { type: "Person", id: "0fce7933-b729-4c8b-bec5-f3b261e2f5a9", }, { type: "Team", id: "1728d91a-001f-421d-90a3-9c8ac337f796", }, ], });
const mockHandler = jest.fn();
recordSet.addEventListener("change", mockHandler);
expect( execute({ schema: recordSet.schema, document: gql` mutation { addRelationship( field: "lineManager" source: "267d5cb0-90aa-471c-b5fc-3b31afd73184" target: "668b05fc-7e2a-492b-9ba3-8ee4cedbfdb9" ) { id ... on Role { lineManager { id } } } } `, }), ).toEqual({ data: { addRelationship: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", lineManager: { id: "668b05fc-7e2a-492b-9ba3-8ee4cedbfdb9", }, }, }, });
expect( execute({ schema: recordSet.schema, document: gql` mutation { addRelationship( field: "responsibilities" source: "267d5cb0-90aa-471c-b5fc-3b31afd73184" target: "bb3c823a-1a2a-4a8a-b650-14a54f595444" ) { id ... on Role { responsibilities { id } } } } `, }), ).toEqual({ data: { addRelationship: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", responsibilities: [ { id: "bb3c823a-1a2a-4a8a-b650-14a54f595444", }, ], }, }, });
expect( execute({ schema: recordSet.schema, document: gql` mutation { addRelationship( field: "holder" source: "267d5cb0-90aa-471c-b5fc-3b31afd73184" target: "0fce7933-b729-4c8b-bec5-f3b261e2f5a9" ) { id ... on Role { holder { id } } } } `, }), ).toEqual({ data: { addRelationship: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", holder: { id: "0fce7933-b729-4c8b-bec5-f3b261e2f5a9", }, }, }, });
expect( execute({ schema: recordSet.schema, document: gql` mutation { addRelationship( field: "teams" source: "267d5cb0-90aa-471c-b5fc-3b31afd73184" target: "1728d91a-001f-421d-90a3-9c8ac337f796" ) { id ... on Role { teams { id } } } } `, }), ).toEqual({ data: { addRelationship: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", teams: [ { id: "1728d91a-001f-421d-90a3-9c8ac337f796", }, ], }, }, });
expect( execute({ schema: recordSet.schema, document: gql` query { role(id: "267d5cb0-90aa-471c-b5fc-3b31afd73184") { id ... on Role { lineManager { id } responsibilities { id } holder { id } teams { id } } } } `, }), ).toEqual({ data: { role: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", lineManager: { id: "668b05fc-7e2a-492b-9ba3-8ee4cedbfdb9", }, responsibilities: [ { id: "bb3c823a-1a2a-4a8a-b650-14a54f595444", }, ], holder: { id: "0fce7933-b729-4c8b-bec5-f3b261e2f5a9", }, teams: [ { id: "1728d91a-001f-421d-90a3-9c8ac337f796", }, ], }, }, });
expect(mockHandler).toHaveBeenCalledTimes(4);
recordSet.removeEventListener("change", mockHandler); });
test("addRelationship enforce unique one-to-x relationships", () => { const recordSet = new RecordSet(COMPLEX_SCHEMA, { init: [ { type: "Role", id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", holder: "0fce7933-b729-4c8b-bec5-f3b261e2f5a9", responsibilities: ["50617c1a-1398-40a2-9d36-fdac87e2e9aa"], }, { type: "Role", id: "b7290c75-9f4b-4b3c-987d-3ea5b7a707ed", responsibilities: [], }, { type: "Responsibility", id: "50617c1a-1398-40a2-9d36-fdac87e2e9aa", }, { type: "Person", id: "0fce7933-b729-4c8b-bec5-f3b261e2f5a9", }, ], });
expect( execute({ schema: recordSet.schema, document: gql` mutation { addRelationship( field: "holder" source: "b7290c75-9f4b-4b3c-987d-3ea5b7a707ed" target: "0fce7933-b729-4c8b-bec5-f3b261e2f5a9" ) { id ... on Role { holder { id } } } } `, }), ).toEqual({ data: { addRelationship: { id: "b7290c75-9f4b-4b3c-987d-3ea5b7a707ed", holder: { id: "0fce7933-b729-4c8b-bec5-f3b261e2f5a9", }, }, }, });
expect( execute({ schema: recordSet.schema, document: gql` mutation { addRelationship( field: "responsibilities" source: "b7290c75-9f4b-4b3c-987d-3ea5b7a707ed" target: "50617c1a-1398-40a2-9d36-fdac87e2e9aa" ) { id ... on Role { responsibilities { id } } } } `, }), ).toEqual({ data: { addRelationship: { id: "b7290c75-9f4b-4b3c-987d-3ea5b7a707ed", responsibilities: [ { id: "50617c1a-1398-40a2-9d36-fdac87e2e9aa", }, ], }, }, });
expect( execute({ schema: recordSet.schema, document: gql` query { role(id: "267d5cb0-90aa-471c-b5fc-3b31afd73184") { id ... on Role { holder { id } responsibilities { id } } } } `, }), ).toEqual({ data: { role: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", holder: null, responsibilities: [], }, }, }); });
test("removeRelationship", () => { const recordSet = new RecordSet(COMPLEX_SCHEMA, { init: [ { type: "Role", id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", lineManager: "668b05fc-7e2a-492b-9ba3-8ee4cedbfdb9", responsibilities: ["bb3c823a-1a2a-4a8a-b650-14a54f595444"], holder: "0fce7933-b729-4c8b-bec5-f3b261e2f5a9", teams: ["1728d91a-001f-421d-90a3-9c8ac337f796"], }, { type: "Role", id: "668b05fc-7e2a-492b-9ba3-8ee4cedbfdb9", }, { type: "Responsibility", id: "bb3c823a-1a2a-4a8a-b650-14a54f595444", }, { type: "Person", id: "0fce7933-b729-4c8b-bec5-f3b261e2f5a9", }, { type: "Team", id: "1728d91a-001f-421d-90a3-9c8ac337f796", }, ], });
const mockHandler = jest.fn();
recordSet.addEventListener("change", mockHandler);
expect( execute({ schema: recordSet.schema, document: gql` mutation { removeRelationship( field: "lineManager" source: "267d5cb0-90aa-471c-b5fc-3b31afd73184" target: "668b05fc-7e2a-492b-9ba3-8ee4cedbfdb9" ) { id ... on Role { lineManager { id } } } } `, }), ).toEqual({ data: { removeRelationship: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", lineManager: null, }, }, });
expect( execute({ schema: recordSet.schema, document: gql` mutation { removeRelationship( field: "responsibilities" source: "267d5cb0-90aa-471c-b5fc-3b31afd73184" target: "bb3c823a-1a2a-4a8a-b650-14a54f595444" ) { id ... on Role { responsibilities { id } } } } `, }), ).toEqual({ data: { removeRelationship: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", responsibilities: [], }, }, });
expect( execute({ schema: recordSet.schema, document: gql` mutation { removeRelationship( field: "holder" source: "267d5cb0-90aa-471c-b5fc-3b31afd73184" target: "0fce7933-b729-4c8b-bec5-f3b261e2f5a9" ) { id ... on Role { holder { id } } } } `, }), ).toEqual({ data: { removeRelationship: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", holder: null, }, }, });
expect( execute({ schema: recordSet.schema, document: gql` mutation { removeRelationship( field: "teams" source: "267d5cb0-90aa-471c-b5fc-3b31afd73184" target: "1728d91a-001f-421d-90a3-9c8ac337f796" ) { id ... on Role { teams { id } } } } `, }), ).toEqual({ data: { removeRelationship: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", teams: [], }, }, });
expect( execute({ schema: recordSet.schema, document: gql` query { role(id: "267d5cb0-90aa-471c-b5fc-3b31afd73184") { id ... on Role { lineManager { id } responsibilities { id } holder { id } teams { id } } } } `, }), ).toEqual({ data: { role: { id: "267d5cb0-90aa-471c-b5fc-3b31afd73184", lineManager: null, responsibilities: [], holder: null, teams: [], }, }, });
expect(mockHandler).toHaveBeenCalledTimes(4);
recordSet.removeEventListener("change", mockHandler); });});
describe("RecordSet query", () => { test("variables", () => { const recordSet = new RecordSet( { Thing: { meta: { singular: "thing", plural: "things", }, fields: { name: { type: "String", }, }, }, }, { init: [ { type: "Thing", id: "3a3b76bc-5146-4ed2-a00c-3b11003f4f1b", name: "Example thing", }, ], }, );
expect( recordSet.query( gql` query ($id: String) { thing(id: $id) { name } } `, { id: "3a3b76bc-5146-4ed2-a00c-3b11003f4f1b" }, ), ).toEqual({ thing: { name: "Example thing", }, }); });
test("error handling", () => { const consoleLogSpy = jest.spyOn(console, "log").mockImplementation(() => {});
const recordSet = new RecordSet({ Thing: { meta: { singular: "thing", plural: "things", }, fields: { name: { type: "String", }, }, }, });
expect( recordSet.query(gql` query { thing { id } } `), ).toEqual({ thing: null, });
expect(console.log).toHaveBeenCalled();
consoleLogSpy.mockRestore(); });});
describe("RecordSet persistence", () => { test("custom", () => { const persistence = { load: jest .fn() .mockReturnValue([{ type: "Thing", id: "f365bb65-16b2-4053-bbf3-cd207afaa798" }]), save: jest.fn(), }; const recordSet = new RecordSet( { Thing: { meta: { singular: "thing", plural: "things", }, fields: {}, }, }, { persistence, }, ); recordSet.query(gql` mutation { createThing(id: "7cd41d28-810b-4f63-b527-5c376e2571be") { id } } `); expect(persistence.load.mock.calls.length).toBe(1); expect(persistence.save.mock.calls.length).toBe(1); expect(persistence.save.mock.calls[0][0]).toEqual([ { type: "Thing", id: "f365bb65-16b2-4053-bbf3-cd207afaa798" }, { type: "Thing", id: "7cd41d28-810b-4f63-b527-5c376e2571be" }, ]); });
browserOnlyTest("LocalStoragePersistence", () => { const getItemSpy = jest .spyOn(global.Storage.prototype, "getItem") .mockReturnValue( JSON.stringify([{ type: "Thing", id: "8681019f-6c9e-466c-8867-6844b1b7b3c6" }]), ); const setItemSpy = jest.spyOn(global.Storage.prototype, "setItem"); const persistence = new LocalStoragePersistence(); const recordSet = new RecordSet( { Thing: { meta: { singular: "thing", plural: "things", }, fields: {}, }, }, { persistence, }, ); recordSet.query(gql` mutation { createThing(id: "a419c660-dcb6-4ed2-af4b-8a7fef2c0761") { id } } `); expect(getItemSpy.mock.calls.length).toBe(1); expect(getItemSpy.mock.calls[0][0]).toBe("recordSet"); expect(setItemSpy.mock.calls.length).toBe(1); expect(setItemSpy.mock.calls[0][0]).toBe("recordSet"); expect(setItemSpy.mock.calls[0][1]).toBe( JSON.stringify([ { type: "Thing", id: "8681019f-6c9e-466c-8867-6844b1b7b3c6" }, { type: "Thing", id: "a419c660-dcb6-4ed2-af4b-8a7fef2c0761" }, ]), ); getItemSpy.mockRestore(); setItemSpy.mockRestore(); });
browserOnlyTest("UrlPersistence", () => { history.replaceState( null, "", `#${toBase64( JSON.stringify([{ type: "Thing", id: "0d07ed2f-20bb-414b-bea1-362a19bebda5" }]), true, )}`, ); const setReplaceState = jest.spyOn(history, "replaceState"); const persistence = new UrlPersistence(); const recordSet = new RecordSet( { Thing: { meta: { singular: "thing", plural: "things", }, fields: {}, }, }, { persistence, }, ); recordSet.query(gql` mutation { createThing(id: "0888f6d3-33a2-4818-81e8-311adb5093ae") { id } } `); expect(setReplaceState.mock.calls.length).toBe(1); expect(setReplaceState.mock.calls[0][2]).toBe( `#${toBase64( JSON.stringify([ { type: "Thing", id: "0d07ed2f-20bb-414b-bea1-362a19bebda5" }, { type: "Thing", id: "0888f6d3-33a2-4818-81e8-311adb5093ae" }, ]), true, )}`, ); setReplaceState.mockRestore(); history.replaceState(null, "", " "); });});
describe("schema helpers", () => { test("StringField", () => { expect(StringField()).toEqual({ type: "String", }); });
test("NumberField", () => { expect(NumberField()).toEqual({ type: "Number", }); });
test("BooleanField", () => { expect(BooleanField()).toEqual({ type: "Boolean", }); });
test("DateField", () => { expect(DateField()).toEqual({ type: "Date", }); });
test("ForeignKeyField", () => { expect(ForeignKeyField("manyToOne")).toEqual({ type: "ForeignKey", cardinality: "manyToOne", }); expect(ForeignKeyField("oneToMany")).toEqual({ type: "ForeignKey", cardinality: "oneToMany", }); expect(ForeignKeyField("oneToOne")).toEqual({ type: "ForeignKey", cardinality: "oneToOne", }); expect(ForeignKeyField("manyToMany")).toEqual({ type: "ForeignKey", cardinality: "manyToMany", }); expect(ForeignKeyField("manyToOne", "Person")).toEqual({ type: "ForeignKey", cardinality: "manyToOne", target: "Person", }); });
test("DateField", () => { expect(InverseField("Role#lineManager")).toEqual({ type: "Inverse", source: { type: "Role", field: "lineManager", }, }); expect(InverseField(["Role#lineManager", "Foo#bar"])).toEqual({ type: "Inverse", source: [ { type: "Role", field: "lineManager", }, { type: "Foo", field: "bar", }, ], }); });
test("full schema", () => { const recordSet = new RecordSet({ Role: { meta: { singular: "role", plural: "roles", }, fields: { name: StringField(), rank: NumberField(), isArchived: BooleanField(), dateCreated: DateField(), lineManager: ForeignKeyField("manyToOne"), responsibilities: ForeignKeyField("oneToMany"), holder: ForeignKeyField("oneToOne"), teams: ForeignKeyField("manyToMany"), reports: InverseField("Role#lineManager"), }, }, Responsibility: { meta: { singular: "responsibility", plural: "responsibilities", }, fields: { owner: InverseField("Role#responsibilities"), }, }, Person: { meta: { singular: "person", plural: "people", }, fields: { role: InverseField("Role#holder"), }, }, Team: { meta: { singular: "team", plural: "teams", }, fields: { members: InverseField("Role#teams"), }, }, }); expect(printSchema(recordSet.schema).trim()).toBe( dedent` schema { query: RootQueryType mutation: RootMutationType }
type RootQueryType { relationships(foreignKeys: [ForeignKeyInput]): [Relationship] role(id: String!): Role roles(ids: [String!]): [Role]! responsibility(id: String!): Responsibility responsibilities(ids: [String!]): [Responsibility]! person(id: String!): Person people(ids: [String!]): [Person]! team(id: String!): Team teams(ids: [String!]): [Team]! }
type Relationship { source: Node target: Node }
interface Node { id: String! }
input ForeignKeyInput { type: String! field: String! }
type Role implements Node { id: String! name: String rank: Float isArchived: Boolean dateCreated: String lineManager: Node responsibilities: [Node!]! holder: Node teams: [Node!]! reports: [Node!]! }
type Responsibility implements Node { id: String! owner: Node }
type Person implements Node { id: String! role: Node }
type Team implements Node { id: String! members: [Node!]! }
type RootMutationType { addRelationship(field: String!, source: String!, target: String!): Node removeRelationship(field: String!, source: String!, target: String!): Node createRole(id: String, name: String, rank: Float, isArchived: Boolean, dateCreated: String): Role updateRole(id: String!, name: String, rank: Float, isArchived: Boolean, dateCreated: String): Role deleteRole(id: String!): Role createResponsibility(id: String): Responsibility updateResponsibility(id: String!): Responsibility deleteResponsibility(id: String!): Responsibility createPerson(id: String): Person updatePerson(id: String!): Person deletePerson(id: String!): Person createTeam(id: String): Team updateTeam(id: String!): Team deleteTeam(id: String!): Team } `.trim(), ); });});
describe("useRecordSet", () => { nodeOnlyTest("local storage persistence doesn't error in node", () => { expect(() => { createRecordSet( { Person: { meta: { singular: "person", plural: "people", }, fields: { name: StringField(), }, }, }, { persistence: "localStorage", }, ); }).not.toThrow(); });
nodeOnlyTest("url persistence works in node", () => { expect(() => { createRecordSet( { Person: { meta: { singular: "person", plural: "people", }, fields: { name: StringField(), }, }, }, { persistence: "url", }, ); }).not.toThrow(); });
browserOnlyTest("end to end", () => { const { useRecordSet, updateRecordSet } = createRecordSet( { Role: { meta: { singular: "role", plural: "roles", }, fields: { name: StringField(), rank: NumberField(), isArchived: BooleanField(), dateCreated: DateField(), lineManager: ForeignKeyField("manyToOne"), responsibilities: ForeignKeyField("oneToMany"), holder: ForeignKeyField("oneToOne"), teams: ForeignKeyField("manyToMany"), reports: InverseField("Role#lineManager"), }, }, Responsibility: { meta: { singular: "responsibility", plural: "responsibilities", }, fields: { owner: InverseField("Role#responsibilities"), }, }, Person: { meta: { singular: "person", plural: "people", }, fields: { role: InverseField("Role#holder"), }, }, Team: { meta: { singular: "team", plural: "teams", }, fields: { members: InverseField("Role#teams"), }, }, }, { persistence: "url", }, ); const { result } = renderHook(() => useRecordSet(gql` query { roles { id name rank } } `), );
act(() => { updateRecordSet(gql` mutation { createRole(id: "de483855-adcb-4fad-9825-69bc72d3c35c", name: "Example", rank: 1) } `); });
expect(result.current?.roles).toEqual([ { id: "de483855-adcb-4fad-9825-69bc72d3c35c", name: "Example", rank: 1, }, ]);
expect(JSON.parse(fromBase64(window.location.hash.slice(1).trim()))).toEqual([ { type: "Role", id: "de483855-adcb-4fad-9825-69bc72d3c35c", name: "Example", rank: 1, }, ]); });});
describe("foreign key targets", () => { const TARGETS_SCHEMA: Schema = { Group: { meta: { singular: "group", plural: "groups", }, fields: { name: StringField(), owner: ForeignKeyField("manyToOne", "Person"), members: ForeignKeyField("manyToMany", "Person"), }, }, Person: { meta: { singular: "person", plural: "people", }, fields: { name: StringField(), }, }, };
const init = () => [ { type: "Group", id: "3d6ff8ff-d23e-4421-bfe1-b2fabd1ccb8c", name: "Group A", owner: "7de3a1cf-5f26-4c56-b453-5dd2a33697fc", members: [ "7de3a1cf-5f26-4c56-b453-5dd2a33697fc", "3d6ff8ff-d23e-4421-bfe1-b2fabd1ccb8c", "a5e1b0a4-9a5b-4f3e-9d7e-3c1f0b0f4a77", ], }, { type: "Person", id: "7de3a1cf-5f26-4c56-b453-5dd2a33697fc", name: "Person A", }, ];
test("schema generation", () => { expect(printRecordSetSchema(TARGETS_SCHEMA)).toContain( dedent` type Group implements Node { id: String! name: String owner: Person members: [Person!]! } `, ); });
test("unknown target", () => { expect(() => { printRecordSetSchema({ Group: { meta: { singular: "group", plural: "groups", }, fields: { owner: ForeignKeyField("manyToOne", "Person"), }, }, }); }).toThrow("Expected the target of Group#owner (Person) to be in the schema."); });
test("query resolution skips records of other types and missing records", () => { const recordSet = new RecordSet(TARGETS_SCHEMA, { init: init() });
expect( recordSet.query(gql` query { group(id: "3d6ff8ff-d23e-4421-bfe1-b2fabd1ccb8c") { owner { name } members { name } } } `), ).toEqual({ group: { owner: { name: "Person A" }, members: [{ name: "Person A" }], }, }); });
test("addRelationship rejects records of other types", () => { const consoleLogSpy = jest.spyOn(console, "log").mockImplementation(() => {}); const recordSet = new RecordSet(TARGETS_SCHEMA, { init: init() });
expect( recordSet.query(gql` mutation { addRelationship( field: "owner" source: "3d6ff8ff-d23e-4421-bfe1-b2fabd1ccb8c" target: "3d6ff8ff-d23e-4421-bfe1-b2fabd1ccb8c" ) { id } } `), ).toEqual({ addRelationship: null });
expect(consoleLogSpy.mock.calls[0][0].message).toBe( "Unable to add relationship: 3d6ff8ff-d23e-4421-bfe1-b2fabd1ccb8c is not a Person.", );
consoleLogSpy.mockRestore(); });});
describe("typed documents", () => { type ThingQuery = { thing: { name: string | null } | null }; type ThingQueryVariables = { id: string };
const recordSet = new RecordSet( { Thing: { meta: { singular: "thing", plural: "things", }, fields: { name: StringField(), }, }, }, { init: [{ type: "Thing", id: "3a3b76bc-5146-4ed2-a00c-3b11003f4f1b", name: "Example thing" }], }, );
const ThingDocument = gql` query ($id: String!) { thing(id: $id) { name } } ` as TypedDocumentNode<ThingQuery, ThingQueryVariables>;
test("result and variable types are inferred from the document", () => { const result = recordSet.query(ThingDocument, { id: "3a3b76bc-5146-4ed2-a00c-3b11003f4f1b" }); const name: string | null | undefined = result.thing?.name; expect(name).toBe("Example thing");
// These are checked when the tests are compiled. () => { // @ts-expect-error recordSet.query(ThingDocument, { id: 1 }); // @ts-expect-error recordSet.query(ThingDocument).nope; }; });});
describe("printRecordSetSchema", () => { test("prints the generated schema", () => { for (const schema of [ MINIMAL_SCHEMA, SCALAR_FIELDS_SCHEMA, FOREIGN_KEYS_SCHEMA, INVERSE_RELATIONS_SCHEMA, COMPLEX_SCHEMA, ]) { expect(printRecordSetSchema(schema)).toBe(printSchema(new RecordSet(schema).schema)); } });});
describe("CLI", () => { let dir: string;
const expected = "# This file was automatically generated by use-record-set. Do not edit it manually.\n\n" + printRecordSetSchema(INVERSE_RELATIONS_SCHEMA) + "\n";
const run = (...args: Array<string>) => spawnSync(process.execPath, [join(__dirname, "cli.js"), ...args], { cwd: dir, encoding: "utf8", });
const writeSchemaFile = (filename: string, contents: string) => { writeFileSync(join(dir, filename), contents); return filename; };
beforeEach(() => { dir = mkdtempSync(join(tmpdir(), "use-record-set-")); });
afterEach(() => { rmSync(dir, { recursive: true, force: true }); });
const json = JSON.stringify(INVERSE_RELATIONS_SCHEMA);
nodeOnlyTest("CommonJS default export", () => { const file = writeSchemaFile("schema.js", `module.exports = ${json};`); const result = run("print-schema", file); expect(result.stderr).toBe(""); expect(result.status).toBe(0); expect(result.stdout).toBe(expected); });
nodeOnlyTest("CommonJS compiled from an ES module", () => { const file = writeSchemaFile( "schema.js", `Object.defineProperty(exports, "__esModule", { value: true }); exports.default = ${json};`, ); const result = run("print-schema", file); expect(result.status).toBe(0); expect(result.stdout).toBe(expected); });
nodeOnlyTest("ES module default export", () => { const file = writeSchemaFile("schema.mjs", `export default ${json};`); const result = run("print-schema", file); expect(result.status).toBe(0); expect(result.stdout).toBe(expected); });
nodeOnlyTest("named export", () => { const file = writeSchemaFile("schema.mjs", `export const schema = ${json};`); const result = run("print-schema", file, "--export", "schema"); expect(result.status).toBe(0); expect(result.stdout).toBe(expected); });
nodeOnlyTest("output file", () => { const file = writeSchemaFile("schema.mjs", `export default ${json};`); const result = run("print-schema", file, "-o", "schema.graphql"); expect(result.status).toBe(0); expect(result.stdout).toBe(""); expect(readFileSync(join(dir, "schema.graphql"), "utf8")).toBe(expected); });
nodeOnlyTest("missing export", () => { const file = writeSchemaFile("schema.mjs", `export const schema = ${json};`); const result = run("print-schema", file); expect(result.status).toBe(1); expect(result.stderr).toBe("schema.mjs has no default export (available exports: schema)\n"); });
nodeOnlyTest("export isn't a schema", () => { const file = writeSchemaFile("schema.mjs", `export default 1;`); const result = run("print-schema", file); expect(result.status).toBe(1); expect(result.stderr).toBe("The default export of schema.mjs is not a schema object\n"); });
nodeOnlyTest("usage errors", () => { expect(run().stderr).toMatch(/^Missing command\n\nUsage:/); expect(run("print").stderr).toMatch(/^Unknown command: print\n\nUsage:/); expect(run("print-schema").stderr).toMatch(/^Missing schema file\n\nUsage:/); expect(run("print-schema", "schema.js", "--nope").stderr).toMatch(/^Unknown option: --nope/); expect(run("print-schema", "schema.js", "-o").stderr).toMatch(/^Missing value for -o/); expect(run("print-schema", "schema.js", "--watch").stderr).toMatch( /^--watch requires --output/, ); expect(run("print-schema").status).toBe(1); });
nodeOnlyTest("help", () => { const result = run("--help"); expect(result.status).toBe(0); expect(result.stdout).toMatch(/^Usage: use-record-set print-schema/); });});