prostgles-server 4.2.140 → 4.2.142

package/lib/Auth/{setAuthSignup.ts → setAuthProviders.ts}

@@ -1,16 +1,18 @@
 import { Auth } from './AuthTypes';
-import passport from "passport";
+/** For some reason normal import is undefined */
+const passport = require("passport") as typeof import("passport");
 import { Strategy as GoogleStrategy } from "passport-google-oauth20";
 import { Strategy as GitHubStrategy } from "passport-github2";
 import { Strategy as MicrosoftStrategy } from "passport-microsoft";
 import { Strategy as FacebookStrategy } from "passport-facebook";
 import { AuthSocketSchema, getKeys, isDefined, isEmpty } from "prostgles-types";
+import { AUTH_ROUTES_AND_PARAMS, AuthHandler } from "./AuthHandler";
 
-export const setAuthSignup = ({ registrations, app }: Required<Auth>["expressConfig"]) => {
+export function setAuthProviders (this: AuthHandler, { registrations, app }: Required<Auth>["expressConfig"]) {
   if(!registrations) return;
   const { email, onRegister, websiteUrl, ...providers } = registrations;
   if(email){
-    app.post("/signup", async (req, res) => {
+    app.post(AUTH_ROUTES_AND_PARAMS.emailSignup, async (req, res) => {
       const { username, password } = req.body;
       if(typeof username !== "string" || typeof password !== "string"){
         res.status(400).json({ msg: "Invalid username or password" });
@@ -53,7 +55,7 @@ export const setAuthSignup = ({ registrations, app }: Required<Auth>["expressCon
     providerName,
   }) => {
 
-    const callbackPath = `/auth/${providerName}/callback`;
+    const callbackPath = `${AUTH_ROUTES_AND_PARAMS.loginWithProvider}/${providerName}/callback`;
     passport.use(
       new (strategy as typeof GoogleStrategy)(
         {
@@ -68,7 +70,7 @@ export const setAuthSignup = ({ registrations, app }: Required<Auth>["expressCon
       )
     );
 
-    app.get(`/auth/${providerName}`,
+    app.get(`${AUTH_ROUTES_AND_PARAMS.loginWithProvider}/${providerName}`,
       passport.authenticate(providerName, authOpts ?? {})
     );
 
@@ -82,7 +84,8 @@ export const setAuthSignup = ({ registrations, app }: Required<Auth>["expressCon
   });
 }
 
-export const getProviders = (registrations: Required<Auth>["expressConfig"]["registrations"]): AuthSocketSchema["providers"] | undefined => {
+export function getProviders(this: AuthHandler): AuthSocketSchema["providers"] | undefined {
+  const { registrations } = this.opts?.expressConfig ?? {}
   if(!registrations) return undefined;
   const { 
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -95,7 +98,7 @@ export const getProviders = (registrations: Required<Auth>["expressConfig"]["reg
   getKeys(providers).forEach(providerName => {
     if(providers[providerName]?.clientID){
       result[providerName] = {
-        url: `/auth/${providerName}`,
+        url: `${AUTH_ROUTES_AND_PARAMS.loginWithProvider}/${providerName}`,
       }
     }
   });

package/lib/Auth/setupAuthRoutes.ts

@@ -0,0 +1,169 @@
+import { DBOFullyTyped } from "../DBSchemaBuilder";
+import { AUTH_ROUTES_AND_PARAMS, AuthHandler, getLoginClientInfo, HTTPCODES } from "./AuthHandler";
+import { AuthClientRequest, ExpressReq, ExpressRes } from "./AuthTypes";
+import { setAuthProviders } from "./setAuthProviders";
+
+export async function setupAuthRoutes(this: AuthHandler) {
+  if (!this.opts) return;
+ 
+  const { login, getUser, expressConfig } = this.opts;
+
+  if (!login) {
+    throw "Invalid auth: Provide { sidKeyName: string } ";
+  }
+
+  if ((AUTH_ROUTES_AND_PARAMS.sidKeyName as any) === "sid") {
+    throw "sidKeyName cannot be 'sid' due to collision with socket.io";
+  }
+
+  if (!getUser) throw "getUser missing from auth config";
+
+  if (!expressConfig) {
+    return 
+  }
+  const { app, publicRoutes = [], onGetRequestOK, magicLinks, use } = expressConfig;
+  if (publicRoutes.find(r => typeof r !== "string" || !r)) {
+    throw "Invalid or empty string provided within publicRoutes "
+  }
+
+  setAuthProviders.bind(this)(expressConfig);
+
+  if(use){
+    app.use((req, res, next) => {
+      use({ 
+        req, 
+        res, 
+        next, 
+        getUser: () => this.getUser({ httpReq: req }) as any,
+        dbo: this.dbo as DBOFullyTyped, 
+        db: this.db,
+      })
+    })
+  }
+
+  if (magicLinks) {
+    const { check } = magicLinks;
+    if (!check) {
+      throw "Check must be defined for magicLinks";
+    }
+
+    app.get(AUTH_ROUTES_AND_PARAMS.magicLinksExpressRoute, async (req: ExpressReq, res: ExpressRes) => {
+      const { id } = req.params ?? {};
+
+      if (typeof id !== "string" || !id) {
+        res.status(HTTPCODES.BAD_REQUEST).json({ msg: "Invalid magic-link id. Expecting a string" });
+      } else {
+        try {
+          const session = await this.throttledFunc(async () => {
+            return check(id, this.dbo as any, this.db, getLoginClientInfo({ httpReq: req }));
+          });
+          if (!session) {
+            res.status(HTTPCODES.AUTH_ERROR).json({ msg: "Invalid magic-link" });
+          } else {
+            this.setCookieAndGoToReturnURLIFSet(session, { req, res });
+          }
+
+        } catch (e) {
+          res.status(HTTPCODES.AUTH_ERROR).json({ msg: e });
+        }
+      }
+    });
+  }
+
+  app.post(AUTH_ROUTES_AND_PARAMS.login, async (req: ExpressReq, res: ExpressRes) => {
+    try {
+      const start = Date.now();
+      const { sid, expires } = await this.loginThrottled(req.body || {}, getLoginClientInfo({ httpReq: req })) || {};
+      await this.prostgles.opts.onLog?.({
+        type: "auth",
+        command: "login",
+        duration: Date.now() - start,
+        sid,
+        socketId: undefined,
+      })
+      if (sid) {
+
+        this.setCookieAndGoToReturnURLIFSet({ sid, expires }, { req, res });
+
+      } else {
+        throw ("Internal error: no user or session")
+      }
+    } catch (err) {
+      console.log(err)
+      res.status(HTTPCODES.AUTH_ERROR).json({ err });
+    }
+
+  });
+
+  if (AUTH_ROUTES_AND_PARAMS.logoutGetPath && this.opts.logout) {
+    app.get(AUTH_ROUTES_AND_PARAMS.logoutGetPath, async (req: ExpressReq, res: ExpressRes) => {
+      const sid = this.validateSid(req?.cookies?.[AUTH_ROUTES_AND_PARAMS.sidKeyName]);
+      if (sid) {
+        try {
+          await this.throttledFunc(() => {
+            return this.opts!.logout!(req?.cookies?.[AUTH_ROUTES_AND_PARAMS.sidKeyName], this.dbo as any, this.db);
+          })
+        } catch (err) {
+          console.error(err);
+        }
+      }
+      res.redirect("/")
+    });
+  }
+
+  if (Array.isArray(publicRoutes)) {
+
+    /* Redirect if not logged in and requesting non public content */
+    app.get(AUTH_ROUTES_AND_PARAMS.catchAll, async (req: ExpressReq, res: ExpressRes, next) => {
+
+      const clientReq: AuthClientRequest = { httpReq: req };
+      const getUser = this.getUser;
+      if(this.prostgles.restApi){
+        if(Object.values(this.prostgles.restApi.routes).some(restRoute => this.matchesRoute(restRoute.split("/:")[0], req.path))){
+          next();
+          return;
+        }
+      }
+      try {
+        const returnURL = this.getReturnUrl(req);
+
+        if(this.matchesRoute(AUTH_ROUTES_AND_PARAMS.loginWithProvider, req.path)){
+          next();
+          return;
+        }
+        /**
+         * Requesting a User route
+         */
+        if (this.isUserRoute(req.path)) {
+
+          /* Check auth. Redirect to login if unauthorized */
+          const u = await getUser(clientReq);
+          if (!u) {
+            res.redirect(`${AUTH_ROUTES_AND_PARAMS.login}?returnURL=${encodeURIComponent(req.originalUrl)}`);
+            return;
+          }
+
+          /* If authorized and going to returnUrl then redirect. Otherwise serve file */
+        } else if (returnURL && (await getUser(clientReq))) {
+
+          res.redirect(returnURL);
+          return;
+
+          /** If Logged in and requesting login then redirect to main page */
+        } else if (this.matchesRoute(AUTH_ROUTES_AND_PARAMS.login, req.path) && (await getUser(clientReq))) {
+
+          res.redirect("/");
+          return;
+        }
+
+        onGetRequestOK?.(req, res, { getUser: () => getUser(clientReq), dbo: this.dbo as DBOFullyTyped, db: this.db })
+
+      } catch (error) {
+        console.error(error);
+        const errorMessage = typeof error === "string" ? error : error instanceof Error ? error.message : "";
+        res.status(HTTPCODES.AUTH_ERROR).json({ msg: "Something went wrong when processing your request" + (errorMessage? (": " + errorMessage) : "") });
+      }
+
+    });
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prostgles-server",
-  "version": "4.2.140",
+  "version": "4.2.142",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/tests/client/hooks.spec.ts

@@ -147,10 +147,15 @@ export const clientHooks = async (db: DBHandlerClient, getSocketOptions: (watchS
         expectedRerenders: 3
       });
       assert.equal(results.length, 3);
-      assert.deepStrictEqual(results.slice(0, 2), [
-        { data: undefined, isLoading: true, error: undefined },
+      assert.deepStrictEqual(
+        results[0],
+        { data: undefined, isLoading: true, error: undefined }
+      );
+      /** This fails from time to time */
+      assert.deepStrictEqual(
+        results[1],
         { data: [], error: undefined, isLoading: false },
-      ]);
+      );
       const lastData = results.at(-1)?.data;
       assert.equal(lastData.length, 1);
       const lastDataItem = lastData[0];

package/tests/client/index.ts

@@ -106,10 +106,12 @@ try {
       onReady: async (db, methods, tableSchema, auth, isReconnect) => {
         log(`TEST_NAME: ${TEST_NAME} Started`)
         try {
+          //@ts-ignore
           if(typeof window !== "undefined"){
             const onLog = (...args: any[]) => {
               socket.emit("log", args.map(v => typeof v === "object"? JSON.stringify(v) : v).join(" "));
             }
+            //@ts-ignore
             window.onerror = function myErrorHandler(errorMsg, url, lineNumber) {
               console.error("Error occured: " + errorMsg);
               stopTest({ err: errorMsg });

package/tests/client/package-lock.json

@@ -10,7 +10,7 @@
       "license": "ISC",
       "dependencies": {
         "@types/node": "^20.9.2",
-        "prostgles-client": "^4.0.146",
+        "prostgles-client": "^4.0.147",
         "prostgles-types": "^4.0.51",
         "socket.io-client": "^4.7.5"
       },
@@ -3006,9 +3006,9 @@
       }
     },
     "node_modules/prostgles-client": {
-      "version": "4.0.146",
-      "resolved": "https://registry.npmjs.org/prostgles-client/-/prostgles-client-4.0.146.tgz",
-      "integrity": "sha512-Xpy+mhnIERPly8GXNMvrkcJzDXbqlNMDhW+f+K2PqTceyQPxRVZGeFckWuguHXIy8NYB6qPPXa+nhQaHnag6Hw==",
+      "version": "4.0.147",
+      "resolved": "https://registry.npmjs.org/prostgles-client/-/prostgles-client-4.0.147.tgz",
+      "integrity": "sha512-oMBqHDFbMrI8WoJmHFT4SKygfxLcVqhuaNwRIgFQAgRKc90El99ftzFz7Bn8LYMnqVPjgOrlL6zY3jSH7dwtqA==",
       "license": "MIT",
       "dependencies": {
         "i": "^0.3.7",

package/tests/client/package.json

@@ -13,7 +13,7 @@
   "license": "ISC",
   "dependencies": {
     "@types/node": "^20.9.2",
-    "prostgles-client": "^4.0.146",
+    "prostgles-client": "^4.0.147",
     "prostgles-types": "^4.0.51",
     "socket.io-client": "^4.7.5"
   },

package/tests/clientOnlyQueries.spec.ts

@@ -8,6 +8,12 @@ export const clientOnlyQueries = async (db: DBHandlerClient, auth: AuthHandler,
 
   await describe("Client only queries", async (t) => {
 
+    // await test("Social auth redirect routes work", async ( ) => {
+    //   assert.equal(!!auth.login.withProvider.github, true);
+    //   const response = await fetch("http://localhost:3001/auth/github");
+    //   assert.equal(response.status, 302);
+    // });
+
     await test("SQL Stream more than 1k records", async ( ) => {
       const expectedRowCount = 2e3;
       await tryRunP("", async (resolve, reject) => {
@@ -266,6 +272,7 @@ export const clientOnlyQueries = async (db: DBHandlerClient, auth: AuthHandler,
 
     await test("SQL Stream table fields are the same as on default request", async ( ) => {
       await tryRunP("", async (resolve, reject) => {
+        await db.sql!("TRUNCATE planes RESTART IDENTITY CASCADE;", {});
         await db.sql!("INSERT INTO planes (last_updated) VALUES (56789);", {});
         const res = await db.sql!("SELECT * FROM planes", {}, { returnType: "stream" });
         const listener = async (packet: SocketSQLStreamPacket) => { 
@@ -417,6 +424,7 @@ export const clientOnlyQueries = async (db: DBHandlerClient, auth: AuthHandler,
         const start = Date.now();
     
         await db.planes.delete!();
+        await db.sql!("TRUNCATE planes RESTART IDENTITY CASCADE;", {});
         let inserts = new Array(100).fill(null).map((d, i) => ({ id: i, flight_number: `FN${i}`, x: Math.random(), y: i }));
         await db.planes.insert!(inserts);
       

package/tests/server/index.ts

@@ -197,6 +197,14 @@ function dd(){
 					log(req.originalUrl)
 					res.sendFile(path.join(__dirname, '../../index.html'));
 				},
+				registrations: {
+					websiteUrl: "http://localhost:3001",
+					github: {
+						clientID: "GITHUB_CLIENT_ID",
+						clientSecret: "GITHUB"
+					},
+					onRegister: console.log
+				},
 			}
 		},
 		publishMethods: async (params) => {
@@ -239,7 +247,7 @@ function dd(){
 		],
 		onReady: async ({ dbo, db }) => {
 			log("prostgles onReady");
-
+			
 			try {
 				
 				if(isClientTest){

package/tests/server/package-lock.json

@@ -21,7 +21,7 @@
     },
     "../..": {
       "name": "prostgles-server",
-      "version": "4.2.139",
+      "version": "4.2.141",
       "license": "MIT",
       "dependencies": {
         "body-parser": "^1.20.3",
@@ -216,10 +216,11 @@
       }
     },
     "node_modules/cross-spawn": {
-      "version": "7.0.3",
-      "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz",
-      "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==",
+      "version": "7.0.6",
+      "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz",
+      "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==",
       "dev": true,
+      "license": "MIT",
       "dependencies": {
         "path-key": "^3.1.0",
         "shebang-command": "^2.0.0",
@@ -1396,9 +1397,9 @@
       }
     },
     "cross-spawn": {
-      "version": "7.0.3",
-      "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz",
-      "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==",
+      "version": "7.0.6",
+      "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz",
+      "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==",
       "dev": true,
       "requires": {
         "path-key": "^3.1.0",

package/tests/server/publishTypeCheck.ts

@@ -34,7 +34,8 @@ export const testPublishTypes = () => {
       },
       items3: "*"
     };
-    const p123: PublishFullyTyped<DBSchemaGenerated> = p11; 
+    const p123: PublishFullyTyped<DBSchemaGenerated> = p11;
+    //@ts-ignore 
     const p1234: PublishFullyTyped = p1;
 
     const p12: PublishFullyTyped = "*";

package/lib/Auth/authInit.ts

@@ -1,166 +0,0 @@
-import { DBOFullyTyped } from "../DBSchemaBuilder";
-import { AuthHandler, getLoginClientInfo, HTTPCODES } from "./AuthHandler";
-import { AuthClientRequest, ExpressReq, ExpressRes } from "./AuthTypes";
-import { setAuthSignup } from "./setAuthSignup";
-
-export async function authInit(this: AuthHandler) {
-  if (!this.opts) return;
-
-  this.opts.sidKeyName = this.opts.sidKeyName || "session_id";
-  const { sidKeyName, login, getUser, expressConfig } = this.opts;
-  this.sidKeyName = this.opts.sidKeyName;
-
-  if (typeof sidKeyName !== "string" && !login) {
-    throw "Invalid auth: Provide { sidKeyName: string } ";
-  }
-  /**
-   * Why ??? Collision with socket.io ???
-   */
-  if (this.sidKeyName === "sid") throw "sidKeyName cannot be 'sid' please provide another name.";
-
-  if (!getUser) throw "getUser missing from auth config";
-
-  if (expressConfig) {
-    const { app, publicRoutes = [], onGetRequestOK, magicLinks, use } = expressConfig;
-    if (publicRoutes.find(r => typeof r !== "string" || !r)) {
-      throw "Invalid or empty string provided within publicRoutes "
-    }
-
-    setAuthSignup(expressConfig);
-
-    if(use){
-      app.use((req, res, next) => {
-        use({ 
-          req, 
-          res, 
-          next, 
-          getUser: () => this.getUser({ httpReq: req }) as any,
-          dbo: this.dbo as DBOFullyTyped, 
-          db: this.db,
-        })
-      })
-    }
-
-    if (magicLinks && this.routes.magicLinks) {
-      const { check } = magicLinks;
-      if (!check) throw "Check must be defined for magicLinks";
-
-      app.get(this.routes.magicLinks?.expressRoute, async (req: ExpressReq, res: ExpressRes) => {
-        const { id } = req.params ?? {};
-
-        if (typeof id !== "string" || !id) {
-          res.status(HTTPCODES.BAD_REQUEST).json({ msg: "Invalid magic-link id. Expecting a string" });
-        } else {
-          try {
-            const session = await this.throttledFunc(async () => {
-              return check(id, this.dbo as any, this.db, getLoginClientInfo({ httpReq: req }));
-            });
-            if (!session) {
-              res.status(HTTPCODES.AUTH_ERROR).json({ msg: "Invalid magic-link" });
-            } else {
-              this.setCookieAndGoToReturnURLIFSet(session, { req, res });
-            }
-
-          } catch (e) {
-            res.status(HTTPCODES.AUTH_ERROR).json({ msg: e });
-          }
-        }
-      });
-    }
-
-    const loginRoute = this.routes?.login;
-    if (loginRoute) {
-      app.post(loginRoute, async (req: ExpressReq, res: ExpressRes) => {
-        try {
-          const start = Date.now();
-          const { sid, expires } = await this.loginThrottled(req.body || {}, getLoginClientInfo({ httpReq: req })) || {};
-          await this.prostgles.opts.onLog?.({
-            type: "auth",
-            command: "login",
-            duration: Date.now() - start,
-            sid,
-            socketId: undefined,
-          })
-          if (sid) {
-
-            this.setCookieAndGoToReturnURLIFSet({ sid, expires }, { req, res });
-
-          } else {
-            throw ("Internal error: no user or session")
-          }
-        } catch (err) {
-          console.log(err)
-          res.status(HTTPCODES.AUTH_ERROR).json({ err });
-        }
-
-      });
-
-      if (this.routes.logoutGetPath && this.opts.logout) {
-        app.get(this.routes.logoutGetPath, async (req: ExpressReq, res: ExpressRes) => {
-          const sid = this.validateSid(req?.cookies?.[sidKeyName]);
-          if (sid) {
-            try {
-              await this.throttledFunc(() => {
-                return this.opts!.logout!(req?.cookies?.[sidKeyName], this.dbo as any, this.db);
-              })
-            } catch (err) {
-              console.error(err);
-            }
-          }
-          res.redirect("/")
-        });
-      }
-
-      if (Array.isArray(publicRoutes)) {
-
-        /* Redirect if not logged in and requesting non public content */
-        app.get(this.routes.catchAll, async (req: ExpressReq, res: ExpressRes, next) => {
-          const clientReq: AuthClientRequest = { httpReq: req }
-          const getUser = this.getUser;
-          if(this.prostgles.restApi){
-            if(Object.values(this.prostgles.restApi.routes).some(restRoute => this.matchesRoute(restRoute.split("/:")[0], req.path))){
-              next();
-              return;
-            }
-          }
-          try {
-            const returnURL = this.getReturnUrl(req);
-
-            /**
-             * Requesting a User route
-             */
-            if (this.isUserRoute(req.path)) {
-
-              /* Check auth. Redirect to login if unauthorized */
-              const u = await getUser(clientReq);
-              if (!u) {
-                res.redirect(`${loginRoute}?returnURL=${encodeURIComponent(req.originalUrl)}`);
-                return;
-              }
-
-              /* If authorized and going to returnUrl then redirect. Otherwise serve file */
-            } else if (returnURL && (await getUser(clientReq))) {
-
-              res.redirect(returnURL);
-              return;
-
-              /** If Logged in and requesting login then redirect to main page */
-            } else if (this.matchesRoute(loginRoute, req.path) && (await getUser(clientReq))) {
-
-              res.redirect("/");
-              return;
-            }
-
-            onGetRequestOK?.(req, res, { getUser: () => getUser(clientReq), dbo: this.dbo as DBOFullyTyped, db: this.db })
-
-          } catch (error) {
-            console.error(error);
-            const errorMessage = typeof error === "string" ? error : error instanceof Error ? error.message : "";
-            res.status(HTTPCODES.AUTH_ERROR).json({ msg: "Something went wrong when processing your request" + (errorMessage? (": " + errorMessage) : "") });
-          }
-
-        });
-      }
-    }
-  }
-}