commit ac3714f05e3eb131b6794709b59d8ede273eb3a3 Author: Mikayla Dobson Date: Sun Jan 28 21:03:19 2024 -0600 init diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e9dbaca --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +node_modules +certs +package-lock.json +*.env +package-lock.json diff --git a/actions/constrained.ts b/actions/constrained.ts new file mode 100644 index 0000000..da2fb10 --- /dev/null +++ b/actions/constrained.ts @@ -0,0 +1,17 @@ +import { z } from 'zod'; + +export class AssertConstrained> { + itemSchema: z.ZodSchema; + + constructor(itemSchema: z.ZodSchema) { + this.itemSchema = itemSchema; + } + + check(item: unknown): item is T { + return this.itemSchema.safeParse(item).success; + } + + checkArray(arr: unknown[]): arr is T[] { + return this.itemSchema.array().safeParse(arr).success; + } +} diff --git a/actions/relation.ts b/actions/relation.ts new file mode 100644 index 0000000..019aa39 --- /dev/null +++ b/actions/relation.ts @@ -0,0 +1,67 @@ +import { z } from "zod"; +import createMongoClient from "../lib/mongoClient"; + +export type AssertRelationConfig, R extends Record> = { + db: string; + mainCollection: string; + mainSchema: z.ZodSchema; + relationCollection: string; + relationSchema: z.ZodSchema; + relations: { + [key in keyof T]?: keyof R; + } +} + +export class AssertRelation, R extends Record> { + config: AssertRelationConfig; + + constructor(config: AssertRelationConfig) { + this.config = config; + } + + static async check, R extends Record>(config: AssertRelationConfig) { + const controller = new AssertRelation(config); + return await controller.check(); + } + + async check() { + try { + const client = await createMongoClient(); + if (!client) return null; + + const db = client.db(this.config.db); + const collection = db.collection(this.config.mainCollection); + const relationCollection = db.collection(this.config.relationCollection); + + const relationResults = await relationCollection.find().toArray(); + const validatedRelationResults = this.config.relationSchema.array().parse(relationResults); + + const mainResults = await collection.find().toArray(); + const validatedMainResults = this.config.mainSchema.array().parse(mainResults); + + let i = 0; + + for (const item of validatedMainResults) { + i++; + for (const key in this.config.relations) { + const value = this.config.relations[key as keyof T] as keyof R; + const relation = item[key as keyof T]; + const options = new Set(); + + Object.values(this.config.relations).forEach((value) => { + validatedRelationResults.forEach((item) => options.add(item[value as keyof R])) + }); + + if (!options.has(relation as unknown as R[keyof R])) { + throw new Error(`Encountered invalid relation in ${this.config.mainCollection}.${key}: ${relation}`); + } + } + } + + return i; + } catch(e) { + console.log(e); + return null; + } + } +} diff --git a/actions/unique.ts b/actions/unique.ts new file mode 100644 index 0000000..c4a3c5f --- /dev/null +++ b/actions/unique.ts @@ -0,0 +1,19 @@ +import type { z } from 'zod'; + +export type CollectionParameters = Partial> + +export const AssertUnique = (itemSchema: z.ZodSchema, parameters?: CollectionParameters) => + itemSchema.array().refine((val) => { + for (const key in parameters) { + const value = parameters[key as keyof CollectionParameters]; + const unique = value?.unique ?? false; + + if (unique) { + const values = val.map((item) => item[key as keyof T]); + return values.length === new Set(values).size; + } + } + }, { + message: "Encountered duplicate values in unique field" + } +); diff --git a/index.ts b/index.ts new file mode 100644 index 0000000..9307665 --- /dev/null +++ b/index.ts @@ -0,0 +1,58 @@ +import dotenv from 'dotenv'; +import { MusicCollection, MusicEntry } from './lib/schema'; +import { AssertUnique } from './actions/unique'; +import { AssertRelation } from './actions/relation'; +import { createMongoClient } from './lib/mongoClient'; + +dotenv.config(); + +async function main() { + try { + const client = await createMongoClient(); + if (!client) return null; + + const mdotdev = client.db('mikayladotdev'); + const music = mdotdev.collection('music'); + + const musicData = await music.find().toArray(); + const collectionData = await mdotdev.collection('music-collection').find().toArray(); + + // validate against internal schema + const MusicEntries = AssertUnique(MusicEntry, { + slug: { unique: true } + }); + + const MusicCollections = AssertUnique(MusicCollection, { + collectionslug: { unique: true } + }); + + const result = AssertRelation.check({ + db: "mikayladotdev", + mainCollection: "music", + relationCollection: "music-collection", + mainSchema: MusicEntry, + relationSchema: MusicCollection, + relations: { + "collection": "collectionslug" + } + }); + + await Promise.allSettled([ + MusicEntries.parseAsync(musicData), + MusicCollections.parseAsync(collectionData), + result + ]).then((results) => { + results.forEach((result) => { + if (result.status === 'rejected') { + console.log(result.reason); + } + }) + }).catch(console.error) + .finally(() => client.close()); + + } catch(e) { + console.log(e); + } +} + +main().catch(console.error); diff --git a/lib/mongoClient.ts b/lib/mongoClient.ts new file mode 100644 index 0000000..8bee0c8 --- /dev/null +++ b/lib/mongoClient.ts @@ -0,0 +1,24 @@ +import { MongoClient } from "mongodb"; +import path from "path"; + +export async function createMongoClient() { + const url = process.env.MONGO_URL; + const cert = process.env.MONGO_CERT; + + if (!url || !cert) { + throw new Error('Missing environment variables'); + } + + const pathToCert = path.resolve(__dirname, '..', cert); + + try { + const client = new MongoClient(url, { + tlsCertificateKeyFile: pathToCert + }); + + return client; + } catch(e) { + console.log(e); + return null; + } +} diff --git a/lib/schema.ts b/lib/schema.ts new file mode 100644 index 0000000..f7a8419 --- /dev/null +++ b/lib/schema.ts @@ -0,0 +1,27 @@ +import { z } from 'zod'; + +// mongodb ObjectId as zod schema (we'll settle on our definition later) +export const ObjectId = z.any(); + +export const MusicEntry = z.object({ + _id: ObjectId, + name: z.string(), + shortdescription: z.string(), + longdescription: z.string().optional(), + artist: z.string().optional().default("Mikayla Dobson"), + compositiondate: z.string().optional(), + pathtoentry: z.string(), + collection: z.string(), + slug: z.string(), +}) + +export const MusicCollection = z.object({ + _id: ObjectId, + name: z.string(), + description: z.string().optional(), + collectionslug: z.string(), +}) + + +export type MusicEntry = z.infer; +export type MusicCollection = z.infer; diff --git a/package.json b/package.json new file mode 100644 index 0000000..61375ce --- /dev/null +++ b/package.json @@ -0,0 +1,20 @@ +{ + "name": "mongo-assert", + "version": "1.0.0", + "description": "", + "main": "index.js", + "scripts": { + "start": "ts-node index.ts", + "test": "echo \"Error: no test specified\" && exit 1" + }, + "keywords": [], + "author": "", + "license": "ISC", + "dependencies": { + "dotenv": "^16.4.1", + "mongodb": "^6.3.0", + "ts-node": "^10.9.2", + "typescript": "^5.3.3", + "zod": "^3.22.4" + } +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..e075f97 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,109 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + "module": "commonjs", /* Specify what module code is generated. */ + // "rootDir": "./", /* Specify the root folder within your source files. */ + // "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ + // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ + // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ + // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + // "outDir": "./", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ + + /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +}