@snowtop/ent 0.1.0-alpha7 → 0.1.0-alpha8

package/scripts/transform_schema.js

@@ -62,16 +62,18 @@ async function main() {
             getTarget(options.target)
         : typescript_1.default.ScriptTarget.ESNext;
     // filter to only event.ts e.g. for comments and whitespace...
-    //  files = files.filter((f) => f.endsWith("event.ts"));
+    // files = files.filter((f) => f.endsWith("user.ts"));
     files.forEach((file) => {
         // assume valid file since we do glob above
-        const idx = file.lastIndexOf(".ts");
-        const writeFile = file.substring(0, idx) + "2" + ".ts";
+        //    const idx = file.lastIndexOf(".ts");
+        //    const writeFile = file.substring(0, idx) + "2" + ".ts";
+        const writeFile = file;
         let contents = fs.readFileSync(file).toString();
         // go through the file and print everything back if not starting immediately after other position
         const sourceFile = typescript_1.default.createSourceFile(file, contents, target, false, typescript_1.default.ScriptKind.TS);
         const nodes = [];
         let updateImport = false;
+        let removeImports = [];
         const f = {
             trackNode: function (tni) {
                 nodes.push({
@@ -79,6 +81,9 @@ async function main() {
                     importNode: tni.node && typescript_1.default.isImportDeclaration(tni.node),
                     rawString: tni.rawString,
                 });
+                if (tni.removeImports) {
+                    removeImports.push(...tni.removeImports);
+                }
             },
             flagUpdateImport() {
                 updateImport = true;
@@ -91,7 +96,7 @@ async function main() {
         for (const node of nodes) {
             if (updateImport && node.importNode) {
                 const importNode = node.node;
-                const transformedImport = transformImport(importNode, sourceFile);
+                const transformedImport = transformImport(importNode, sourceFile, removeImports);
                 if (transformedImport) {
                     newContents += transformedImport;
                     continue;
@@ -129,62 +134,203 @@ function traverse(fileContents, sourceFile, f) {
     });
     return traversed;
 }
-// TODO need to replace class field member, print that and see what happens
 function traverseClass(fileContents, sourceFile, node, f) {
-    let updated = false;
-    // beginning of class...
-    // including comment
-    let klassContents = fileContents.substring(node.getFullStart(), node.members[0].getFullStart());
+    const ci = getClassInfo(fileContents, sourceFile, node);
+    if (!ci) {
+        return false;
+    }
+    let klassContents = `${ci.comment}const ${ci.name} = new ${ci.class}({\n`;
+    let removeImports = [];
+    if (ci.implementsSchema) {
+        removeImports.push("Schema");
+    }
     for (let member of node.members) {
-        if (!isFieldElement(member, sourceFile)) {
-            klassContents += member.getFullText(sourceFile);
-            continue;
+        const fInfo = getClassElementInfo(fileContents, member, sourceFile);
+        if (!fInfo) {
+            return false;
         }
-        // intentionally doesn't parse decorators since we don't need it
-        let fieldMap = "";
-        // fieldMapComment...
-        const comment = getPreText(fileContents, member, sourceFile);
-        if (comment) {
-            fieldMap += comment;
+        klassContents += `${fInfo.comment}${fInfo.key}:${fInfo.value},\n`;
+        if (fInfo.type) {
+            removeImports.push(fInfo.type);
         }
-        updated = true;
-        // need to change to fields: FieldMap = {code: StringType()};
-        const property = member;
-        const initializer = property.initializer;
-        fieldMap += "fields: FieldMap = {";
-        for (const element of initializer.elements) {
-            const parsed = parseFieldElement(element, sourceFile, fileContents);
-            if (parsed === null) {
-                return false;
+    }
+    klassContents += "\n})";
+    if (ci.export && ci.default) {
+        klassContents += `\n export default ${ci.name};`;
+    }
+    else if (ci.export) {
+        klassContents = "export " + klassContents;
+    }
+    //  console.debug(klassContents);
+    f.trackNode({ rawString: klassContents, removeImports: removeImports });
+    return true;
+}
+function transformSchema(str) {
+    // only do known class names
+    if (str === "BaseEntSchema" || str === "BaseEntSchemaWithTZ") {
+        return str.substring(4);
+    }
+    return str;
+}
+function getClassInfo(fileContents, sourceFile, node) {
+    const className = node.name?.text;
+    let classExtends;
+    let implementsSchema = false;
+    if (node.heritageClauses) {
+        for (const hc of node.heritageClauses) {
+            if (hc.token === typescript_1.default.SyntaxKind.ImplementsKeyword) {
+                for (const type of hc.types) {
+                    if (type.expression.getText(sourceFile) === "Schema") {
+                        implementsSchema = true;
+                    }
+                }
+                continue;
             }
-            const { callEx, name, nameComment, properties } = parsed;
-            let property = "";
-            const fieldComment = getPreText(fileContents, element, sourceFile).trim();
-            if (fieldComment) {
-                property += "\n" + fieldComment + "\n";
+            // ts.SyntaxKind.ExtendsKeyword
+            // can only extend one class
+            for (const type of hc.types) {
+                const text = type.expression.getText(sourceFile);
+                const transformed = transformSchema(text);
+                if (transformed === text) {
+                    return undefined;
+                }
+                classExtends = transformed;
             }
-            if (nameComment) {
-                property += nameComment + "\n";
+        }
+    }
+    if (!className || !node.heritageClauses || !classExtends) {
+        return undefined;
+    }
+    let ci = {
+        name: className,
+        class: classExtends,
+        comment: getPreText(fileContents, node, sourceFile),
+        implementsSchema,
+    };
+    if (node.modifiers) {
+        for (const mod of node.modifiers) {
+            const text = mod.getText(sourceFile);
+            if (text === "export") {
+                ci.export = true;
             }
-            // e.g. UUIDType, StringType etc
-            let call = callEx.expression.getText(sourceFile);
-            let fnCall = "";
-            if (properties.length) {
-                fnCall = `{${properties.join(",")}}`;
+            else if (text === "default") {
+                ci.default = true;
             }
-            property += `${name}:${call}(${fnCall}),`;
-            fieldMap += property;
         }
-        fieldMap += "}";
-        klassContents += fieldMap;
     }
-    klassContents += "\n}";
-    //  console.debug(klassContents);
-    if (!updated) {
-        return updated;
+    return ci;
+}
+// intentionally doesn't parse decorators since we don't need it
+function getClassElementInfo(fileContents, member, sourceFile) {
+    if (isFieldElement(member, sourceFile)) {
+        return getFieldElementInfo(fileContents, member, sourceFile);
     }
-    f.trackNode({ rawString: klassContents });
-    return updated;
+    if (member.kind === typescript_1.default.SyntaxKind.Constructor) {
+        return getConstructorElementInfo(fileContents, member, sourceFile);
+    }
+    if (member.kind !== typescript_1.default.SyntaxKind.PropertyDeclaration) {
+        return;
+    }
+    // other properties
+    const property = member;
+    if (!property.initializer) {
+        return;
+    }
+    const token = property.name;
+    return {
+        key: token.escapedText.toString(),
+        value: property.initializer?.getFullText(sourceFile),
+        comment: getPreText(fileContents, member, sourceFile),
+        type: getType(property, sourceFile),
+    };
+}
+function getType(property, sourceFile) {
+    let propertytype = property.type?.getText(sourceFile) || "";
+    let ends = ["| null", "[]"];
+    for (const end of ends) {
+        if (propertytype.endsWith(end)) {
+            propertytype = propertytype.slice(0, -1 * end.length);
+        }
+    }
+    return propertytype;
+}
+function getFieldElementInfo(fileContents, member, sourceFile) {
+    let fieldMap = "";
+    // need to change to fields: {code: StringType()};
+    const property = member;
+    const initializer = property.initializer;
+    fieldMap += "{";
+    for (const element of initializer.elements) {
+        const parsed = parseFieldElement(element, sourceFile, fileContents);
+        if (parsed === null) {
+            return;
+        }
+        const { callEx, name, nameComment, properties } = parsed;
+        let property = "";
+        const fieldComment = getPreText(fileContents, element, sourceFile).trim();
+        if (fieldComment) {
+            property += "\n" + fieldComment + "\n";
+        }
+        if (nameComment) {
+            property += nameComment + "\n";
+        }
+        // e.g. UUIDType, StringType etc
+        let call = callEx.expression.getText(sourceFile);
+        let fnCall = "";
+        if (properties.length) {
+            fnCall = `{${properties.join(",")}}`;
+        }
+        property += `${name}:${call}(${fnCall}),`;
+        fieldMap += property;
+    }
+    fieldMap += "}";
+    return {
+        key: "fields",
+        value: fieldMap,
+        comment: getPreText(fileContents, member, sourceFile),
+        type: getType(property, sourceFile),
+    };
+}
+function getConstructorElementInfo(fileContents, member, sourceFile) {
+    const c = member;
+    //remove {}
+    let fullText = c.body?.getFullText(sourceFile) || "";
+    fullText = fullText.trim().slice(1, -1).trim();
+    // convert something like
+    /*
+    constructor() {
+      super();
+      this.addPatterns(
+        new Feedback(),
+        new DayOfWeek(),
+        new Feedback(),
+        new DayOfWeek(),
+      );
+    }
+      */
+    // into this.addPatterns(new Feedback(),new DayOfWeek(),new Feedback(),new DayOfWeek(),)
+    const lines = fullText
+        .split("\n")
+        .map((line) => line.trim())
+        .join("")
+        .split(";")
+        .filter((f) => f != "super()" && f != "");
+    // at this point there should be only line for what we handle
+    if (lines.length != 1) {
+        return;
+    }
+    const line = lines[0];
+    const addPatterns = "this.addPatterns(";
+    if (!line.startsWith(addPatterns)) {
+        return;
+    }
+    return {
+        key: "patterns",
+        // remove this.addPatterns at the front, remove trailing ) at the end
+        // if there's a trailing comma, it'll be handled by prettier
+        value: `[${line.slice(addPatterns.length, -1)}]`,
+        comment: "",
+    };
 }
 function isFieldElement(member, sourceFile) {
     if (member.kind !== typescript_1.default.SyntaxKind.PropertyDeclaration) {
@@ -249,7 +395,7 @@ function parseFieldElement(element, sourceFile, fileContents) {
         nameComment: propertyComment,
     };
 }
-function transformImport(importNode, sourceFile) {
+function transformImport(importNode, sourceFile, removeImports) {
     // remove quotes too
     const text = importNode.moduleSpecifier.getText(sourceFile).slice(1, -1);
     if (text !== "@snowtop/ent" &&
@@ -267,16 +413,19 @@ function transformImport(importNode, sourceFile) {
         .substring(start + 1, end)
         //    .trim()
         .split(",");
+    let removeImportsMap = {};
+    removeImports.forEach((imp) => (removeImportsMap[imp] = true));
+    let newImports = [];
     for (let i = 0; i < imports.length; i++) {
-        const imp = imports[i].trim();
-        if (imp === "Field") {
-            imports[i] = "FieldMap";
+        let imp = transformSchema(imports[i].trim());
+        if (removeImportsMap[imp]) {
+            continue;
         }
+        newImports.push(imp);
     }
-    // TODO better to update node instead of doing this but this works for now
     return ("import " +
         importText.substring(0, start + 1) +
-        imports.join(", ") +
+        newImports.join(", ") +
         importText.substring(end) +
         ' from "' +
         text +

package/testutils/builder.d.ts

@@ -1,7 +1,8 @@
 import { Ent, ID, Viewer, Data, EntConstructor } from "../core/base";
 import { Orchestrator } from "../action/orchestrator";
 import { Action, Builder, Changeset, WriteOperation, Validator, Trigger, Observer } from "../action";
-import { Schema } from "../schema";
+import { FieldMap, Schema } from "../schema";
+import { SchemaConfig } from "../schema/base_schema";
 export declare class User implements Ent {
     viewer: Viewer;
     data: Data;
@@ -60,6 +61,9 @@ export declare class Address implements Ent {
 export interface BuilderSchema<T extends Ent> extends Schema {
     ent: EntConstructor<T>;
 }
+export declare function getBuilderSchema<T extends Ent>(cfg: SchemaConfig, ent: EntConstructor<T>): BuilderSchema<T>;
+export declare function getBuilderSchemaFromFields<T extends Ent>(fields: FieldMap, ent: EntConstructor<T>): BuilderSchema<T>;
+export declare function getBuilderSchemaTZFromFields<T extends Ent>(fields: FieldMap, ent: EntConstructor<T>): BuilderSchema<T>;
 export declare function getSchemaName(value: BuilderSchema<Ent>): string;
 export declare function getTableName(value: BuilderSchema<Ent>): string;
 export declare class SimpleBuilder<T extends Ent> implements Builder<T> {

package/testutils/builder.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SimpleAction = exports.SimpleBuilder = exports.getTableName = exports.getSchemaName = exports.Address = exports.Message = exports.Group = exports.Contact = exports.Event = exports.User = void 0;
+exports.SimpleAction = exports.SimpleBuilder = exports.getTableName = exports.getSchemaName = exports.getBuilderSchemaTZFromFields = exports.getBuilderSchemaFromFields = exports.getBuilderSchema = exports.Address = exports.Message = exports.Group = exports.Contact = exports.Event = exports.User = void 0;
 const privacy_1 = require("../core/privacy");
 const orchestrator_1 = require("../action/orchestrator");
 const action_1 = require("../action");
@@ -14,6 +14,7 @@ const snake_case_1 = require("snake-case");
 const loaders_1 = require("../core/loaders");
 const convert_1 = require("../core/convert");
 const camel_case_1 = require("camel-case");
+const base_schema_1 = require("../schema/base_schema");
 class User {
     constructor(viewer, data) {
         this.viewer = viewer;
@@ -85,6 +86,27 @@ class Address {
     }
 }
 exports.Address = Address;
+function getBuilderSchema(cfg, ent) {
+    return {
+        ...new base_schema_1.EntSchema(cfg),
+        ent,
+    };
+}
+exports.getBuilderSchema = getBuilderSchema;
+function getBuilderSchemaFromFields(fields, ent) {
+    return {
+        ...new base_schema_1.EntSchema({ fields }),
+        ent,
+    };
+}
+exports.getBuilderSchemaFromFields = getBuilderSchemaFromFields;
+function getBuilderSchemaTZFromFields(fields, ent) {
+    return {
+        ...new base_schema_1.EntSchemaWithTZ({ fields }),
+        ent,
+    };
+}
+exports.getBuilderSchemaTZFromFields = getBuilderSchemaTZFromFields;
 function getSchemaName(value) {
     return value.ent.name;
 }
@@ -142,12 +164,34 @@ class SimpleBuilder {
                 ent: schema.ent,
                 tableName: tableName,
                 fields: [],
+                fieldPrivacy: (0, schema_1.getFieldsWithPrivacy)(schema),
             },
             builder: this,
             action: action,
             schema: this.schema,
             editedFields: () => {
-                return this.fields;
+                // to simulate what we do in generated builders where we return a new Map
+                const m = new Map();
+                for (const [k, v] of this.fields) {
+                    m.set(k, v);
+                }
+                return m;
+            },
+            updateInput: (input) => {
+                const knownFields = (0, schema_1.getFields)(this.schema);
+                for (const k in input) {
+                    if (knownFields.has(k)) {
+                        this.fields.set(k, input[k]);
+                    }
+                    else {
+                        // related to #510. we do camelCase to pass fields in here but fields may be snakeCase and we want that to pass in tests
+                        // we do camelCase in
+                        const sc = (0, snake_case_1.snakeCase)(k);
+                        if (knownFields.has(sc)) {
+                            this.fields.set(sc, input[k]);
+                        }
+                    }
+                }
             },
         });
     }

package/testutils/context/test_context.d.ts

@@ -1,8 +1,8 @@
 import { Context, Viewer } from "../../core/base";
 import { ContextCache } from "../../core/context";
-import { LoggedOutViewer } from "../../core/viewer";
 export declare class TestContext implements Context {
+    constructor(viewer?: Viewer);
     cache: ContextCache;
-    viewer: LoggedOutViewer;
+    viewer: Viewer;
     getViewer(): Viewer;
 }

package/testutils/context/test_context.js

@@ -4,9 +4,15 @@ exports.TestContext = void 0;
 const context_1 = require("../../core/context");
 const viewer_1 = require("../../core/viewer");
 class TestContext {
-    constructor() {
+    constructor(viewer) {
         this.cache = new context_1.ContextCache();
         this.viewer = new viewer_1.LoggedOutViewer(this);
+        if (viewer) {
+            this.viewer = viewer;
+            if (viewer.setContext !== undefined) {
+                viewer.setContext(this);
+            }
+        }
     }
     getViewer() {
         return this.viewer;

package/testutils/db/test_db.d.ts

@@ -71,10 +71,11 @@ export declare class TempDB {
     constructor(tables: CoreConcept[]);
     getDialect(): Dialect;
     getTables(): Map<string, CoreConcept>;
-    beforeAll(): Promise<void>;
+    beforeAll(setupConnString?: boolean): Promise<void>;
     getSqliteClient(): SqliteDatabase;
     getPostgresClient(): PGClient;
     afterAll(): Promise<void>;
+    getDB(): string;
     dropAll(): Promise<void>;
     drop(...tables: string[]): Promise<void>;
     create(...tables: CoreConcept[]): Promise<void>;

package/testutils/db/test_db.js

@@ -336,7 +336,7 @@ class TempDB {
     getTables() {
         return this.tables;
     }
-    async beforeAll() {
+    async beforeAll(setupConnString = true) {
         if (this.dialect === db_1.Dialect.Postgres) {
             const user = process.env.POSTGRES_USER || "";
             const password = process.env.POSTGRES_PASSWORD || "";
@@ -348,11 +348,17 @@ class TempDB {
             await this.client.connect();
             this.db = randomDB();
             await this.client.query(`CREATE DATABASE ${this.db}`);
-            if (user && password) {
-                process.env.DB_CONNECTION_STRING = `postgres://${user}:${password}@localhost:5432/${this.db}`;
+            if (setupConnString) {
+                if (user && password) {
+                    process.env.DB_CONNECTION_STRING = `postgres://${user}:${password}@localhost:5432/${this.db}`;
+                }
+                else {
+                    process.env.DB_CONNECTION_STRING = `postgres://localhost/${this.db}?`;
+                }
             }
             else {
-                process.env.DB_CONNECTION_STRING = `postgres://localhost/${this.db}?`;
+                // will probably be setup via loadConfig
+                delete process.env.DB_CONNECTION_STRING;
             }
             this.dbClient = new pg_1.Client({
                 host: "localhost",
@@ -397,6 +403,9 @@ class TempDB {
         await this.client.query(`DROP DATABASE ${this.db}`);
         await this.client.end();
     }
+    getDB() {
+        return this.db;
+    }
     async dropAll() {
         for (const [t, _] of this.tables) {
             await this.drop(t);

package/testutils/ent-graphql-tests/index.d.ts

@@ -16,6 +16,8 @@ interface queryConfig {
     callback?: (res: supertest.Response) => void;
     inlineFragmentRoot?: string;
     customHandlers?: RequestHandler[];
+    server?: any;
+    graphQLPath?: string;
 }
 export interface queryRootConfig extends queryConfig {
     root: string;

package/testutils/ent-graphql-tests/index.js

@@ -56,7 +56,7 @@ function server(config) {
         };
         return doWork();
     }));
-    app.use("/graphql", ...handlers);
+    app.use(config.graphQLPath || "/graphql", ...handlers);
     return app;
 }
 function getInnerType(typ, list) {
@@ -72,14 +72,14 @@ function makeGraphQLRequest(config, query, fieldArgs) {
     let test;
     if (config.test) {
         if (typeof config.test === "function") {
-            test = config.test(server(config));
+            test = config.test(config.server ? config.server : server(config));
         }
         else {
             test = config.test;
         }
     }
     else {
-        test = (0, supertest_1.default)(server(config));
+        test = (0, supertest_1.default)(config.server ? config.server : server(config));
     }
     let files = new Map();
     // handle files
@@ -104,7 +104,9 @@ function makeGraphQLRequest(config, query, fieldArgs) {
         }
     });
     if (files.size) {
-        let ret = test.post("/graphql").set(config.headers || {});
+        let ret = test
+            .post(config.graphQLPath || "/graphql")
+            .set(config.headers || {});
         ret.field("operations", JSON.stringify({
             query: query,
             variables: config.args,
@@ -130,7 +132,7 @@ function makeGraphQLRequest(config, query, fieldArgs) {
         return [
             test,
             test
-                .post("/graphql")
+                .post(config.graphQLPath || "/graphql")
                 .set(config.headers || {})
                 .send({
                 query: query,

package/testutils/fake_data/fake_contact.d.ts

@@ -1,6 +1,5 @@
 import { ID, Ent, Viewer, Data, LoadEntOptions, PrivacyPolicy } from "../../core/base";
-import { BuilderSchema, SimpleBuilder } from "../builder";
-import { BaseEntSchema, FieldMap } from "../../schema";
+import { SimpleBuilder } from "../builder";
 import { NodeType } from "./const";
 import { ObjectLoaderFactory } from "../../core/loaders";
 export declare class FakeContact implements Ent {
@@ -22,10 +21,7 @@ export declare class FakeContact implements Ent {
     static load(v: Viewer, id: ID): Promise<FakeContact | null>;
     static loadX(v: Viewer, id: ID): Promise<FakeContact>;
 }
-export declare class FakeContactSchema extends BaseEntSchema implements BuilderSchema<FakeContact> {
-    ent: typeof FakeContact;
-    fields: FieldMap;
-}
+export declare const FakeContactSchema: import("../builder").BuilderSchema<FakeContact>;
 export interface ContactCreateInput {
     firstName: string;
     lastName: string;

package/testutils/fake_data/fake_contact.js

@@ -59,21 +59,14 @@ class FakeContact {
     }
 }
 exports.FakeContact = FakeContact;
-class FakeContactSchema extends schema_1.BaseEntSchema {
-    constructor() {
-        super(...arguments);
-        this.ent = FakeContact;
-        this.fields = {
-            firstName: (0, schema_1.StringType)(),
-            lastName: (0, schema_1.StringType)(),
-            emailAddress: (0, schema_1.StringType)(),
-            userID: (0, schema_1.UUIDType)({
-                foreignKey: { schema: "User", column: "ID" },
-            }),
-        };
-    }
-}
-exports.FakeContactSchema = FakeContactSchema;
+exports.FakeContactSchema = (0, builder_1.getBuilderSchemaFromFields)({
+    firstName: (0, schema_1.StringType)(),
+    lastName: (0, schema_1.StringType)(),
+    emailAddress: (0, schema_1.StringType)(),
+    userID: (0, schema_1.UUIDType)({
+        foreignKey: { schema: "User", column: "ID" },
+    }),
+}, FakeContact);
 function getContactBuilder(viewer, input) {
     const m = new Map();
     for (const key in input) {
@@ -82,7 +75,7 @@ function getContactBuilder(viewer, input) {
     //To lock in the value of Date now incase of advanceTo/advanceBy
     m.set("createdAt", new Date());
     m.set("updatedAt", new Date());
-    return new builder_1.SimpleBuilder(viewer, new FakeContactSchema(), m);
+    return new builder_1.SimpleBuilder(viewer, exports.FakeContactSchema, m);
 }
 exports.getContactBuilder = getContactBuilder;
 async function createContact(viewer, input) {

package/testutils/fake_data/fake_event.d.ts

@@ -1,6 +1,5 @@
 import { ID, Ent, Viewer, Data, LoadEntOptions, PrivacyPolicy } from "../../core/base";
-import { BuilderSchema, SimpleBuilder } from "../builder";
-import { BaseEntSchema, FieldMap } from "../../schema";
+import { SimpleBuilder } from "../builder";
 import { NodeType } from "./const";
 export declare class FakeEvent implements Ent {
     viewer: Viewer;
@@ -23,10 +22,7 @@ export declare class FakeEvent implements Ent {
     static load(v: Viewer, id: ID): Promise<FakeEvent | null>;
     static loadX(v: Viewer, id: ID): Promise<FakeEvent>;
 }
-export declare class FakeEventSchema extends BaseEntSchema implements BuilderSchema<FakeEvent> {
-    ent: typeof FakeEvent;
-    fields: FieldMap;
-}
+export declare const FakeEventSchema: import("../builder").BuilderSchema<FakeEvent>;
 export interface EventCreateInput {
     startTime: Date;
     endTime?: Date | null;