@lowdefy/server 4.0.0-rc.9 → 4.5.0

package/lib/server/auth/getAuthOptions.js

@@ -0,0 +1,35 @@
+/*
+  Copyright 2020-2024 Lowdefy, Inc
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+import { getNextAuthConfig } from '@lowdefy/api';
+import { getSecretsFromEnv } from '@lowdefy/node-utils';
+
+import adapters from '../../../build/plugins/auth/adapters.js';
+import authJson from '../../../build/auth.json';
+import callbacks from '../../../build/plugins/auth/callbacks.js';
+import events from '../../../build/plugins/auth/events.js';
+import providers from '../../../build/plugins/auth/providers.js';
+
+function getAuthOptions({ logger }) {
+  return getNextAuthConfig({
+    authJson,
+    logger,
+    plugins: { adapters, callbacks, events, providers },
+    secrets: getSecretsFromEnv(),
+  });
+}
+
+export default getAuthOptions;

package/lib/{auth → server/auth}/getServerSession.js

@@ -1,5 +1,5 @@
 /*
-  Copyright 2020-2023 Lowdefy, Inc
+  Copyright 2020-2024 Lowdefy, Inc
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -15,10 +15,10 @@
 */
 
 import { getServerSession as getNextAuthServerSession } from 'next-auth/next';
-import { authOptions } from '../../pages/api/auth/[...nextauth].js';
-import authJson from '../../build/auth.json';
 
-function getServerSession({ req, res }) {
+import authJson from '../../../build/auth.json';
+
+function getServerSession({ authOptions, req, res }) {
   if (authJson.configured === true) {
     return getNextAuthServerSession(req, res, authOptions);
   }

package/lib/{fileCache.js → server/fileCache.js}

@@ -1,5 +1,5 @@
 /*
-  Copyright 2020-2023 Lowdefy, Inc
+  Copyright 2020-2024 Lowdefy, Inc
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.

package/lib/server/log/createLogger.js

@@ -0,0 +1,30 @@
+/*
+  Copyright 2020-2024 Lowdefy, Inc
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+import pino from 'pino';
+
+// TODO: Pino does not serialize error.cause properties if the cause object is not an Error (or Error-like)
+const logger = pino({
+  name: 'lowdefy_server',
+  level: process.env.LOWDEFY_LOG_LEVEL ?? 'info',
+  base: { pid: undefined, hostname: undefined },
+});
+
+function createLogger(metadata = {}) {
+  return logger.child(metadata);
+}
+
+export default createLogger;

package/lib/server/log/logError.js

@@ -0,0 +1,72 @@
+/*
+  Copyright 2020-2024 Lowdefy, Inc
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+function logError({ context, error }) {
+  try {
+    const { headers = {}, user = {} } = context;
+
+    context.logger.error({
+      // TODO:
+      // app_name
+      // app_version
+      // lowdefy_version
+      // build_hash
+      // config_hash
+      err: error,
+      user: {
+        id: user.id,
+        roles: user.roles,
+        sub: user.sub,
+        session_id: user.session_id,
+      },
+      url: context.req.url,
+      method: context.req.method,
+      resolvedUrl: context.nextContext?.resolvedUrl,
+      hostname: context.req.hostname,
+      headers: {
+        'accept-language': headers['accept-language'],
+        'sec-ch-ua-mobile': headers['sec-ch-ua-mobile'],
+        'sec-ch-ua-platform': headers['sec-ch-ua-platform'],
+        'sec-ch-ua': headers['sec-ch-ua'],
+        'user-agent': headers['user-agent'],
+        host: headers.host,
+        referer: headers.referer,
+        // Non localhost headers
+        'x-forward-for': headers['x-forward-for'],
+        // Vercel headers
+        'x-vercel-id': headers['x-vercel-id'],
+        'x-real-ip': headers['x-real-ip'],
+        'x-vercel-ip-country': headers['x-vercel-ip-country'],
+        'x-vercel-ip-country-region': headers['x-vercel-ip-country-region'],
+        'x-vercel-ip-city': headers['x-vercel-ip-city'],
+        'x-vercel-ip-latitude': headers['x-vercel-ip-latitude'],
+        'x-vercel-ip-longitude': headers['x-vercel-ip-longitude'],
+        'x-vercel-ip-timezone': headers['x-vercel-ip-timezone'],
+        // Cloudflare headers
+        'cf-connecting-ip': headers['cf-connecting-ip'],
+        'cf-ray': headers['cf-ray'],
+        'cf-ipcountry': headers['cf-ipcountry'],
+        'cf-visitor': headers['cf-visitor'],
+      },
+    });
+  } catch (e) {
+    console.error(error);
+    console.error('An error occurred while logging the error.');
+    console.error(e);
+  }
+}
+
+export default logError;

package/lib/server/log/logRequest.js

@@ -0,0 +1,66 @@
+/*
+  Copyright 2020-2024 Lowdefy, Inc
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+// TODO: Better name needed here maybe?
+function logRequest({ context }) {
+  const { headers = {}, user = {} } = context;
+  context.logger.info({
+    // TODO:
+    // app_name
+    // app_version
+    // lowdefy_version
+    // build_hash
+    // config_hash
+    user: {
+      id: user.id,
+      roles: user.roles,
+      sub: user.sub,
+      session_id: user.session_id, // TODO: Implement session id
+    },
+    url: context.req.url,
+    method: context.req.method,
+    resolvedUrl: context.nextContext?.resolvedUrl,
+    hostname: context.req.hostname,
+    headers: {
+      'accept-language': headers['accept-language'],
+      'sec-ch-ua-mobile': headers['sec-ch-ua-mobile'],
+      'sec-ch-ua-platform': headers['sec-ch-ua-platform'],
+      'sec-ch-ua': headers['sec-ch-ua'],
+      'user-agent': headers['user-agent'],
+      host: headers.host,
+      referer: headers.referer,
+      'x-forward-for': headers['x-forward-for'],
+      // Vercel headers
+      'x-vercel-id': headers['x-vercel-id'],
+      'x-real-ip': headers['x-real-ip'],
+      'x-vercel-ip-country': headers['x-vercel-ip-country'],
+      'x-vercel-ip-country-region': headers['x-vercel-ip-country-region'],
+      'x-vercel-ip-city': headers['x-vercel-ip-city'],
+      'x-vercel-ip-latitude': headers['x-vercel-ip-latitude'],
+      'x-vercel-ip-longitude': headers['x-vercel-ip-longitude'],
+      'x-vercel-ip-timezone': headers['x-vercel-ip-timezone'],
+      // Cloudflare headers
+      'cf-connecting-ip': headers['cf-connecting-ip'],
+      'cf-ray': headers['cf-ray'],
+      'cf-ipcountry': headers['cf-ipcountry'],
+      'cf-visitor': headers['cf-visitor'],
+    },
+  });
+  // TODO:
+  // Next local? nextContext.locale, nextContext.locales, nextContext.defaultLocale
+}
+
+export default logRequest;

package/lib/server/serverSidePropsWrapper.js

@@ -0,0 +1,60 @@
+/*
+  Copyright 2020-2024 Lowdefy, Inc
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+import path from 'path';
+import crypto from 'crypto';
+import { createApiContext } from '@lowdefy/api';
+
+import config from '../../build/config.json';
+import createLogger from './log/createLogger.js';
+import fileCache from './fileCache.js';
+import getServerSession from './auth/getServerSession.js';
+import logError from './log/logError.js';
+import logRequest from './log/logRequest.js';
+import getAuthOptions from './auth/getAuthOptions.js';
+
+// TODO: Merge serverSidePropsWrapper and apiWrapper?
+function serverSidePropsWrapper(handler) {
+  return async function wrappedHandler(nextContext) {
+    const context = {
+      // Important to give absolute path so Next can trace build files
+      rid: crypto.randomUUID(),
+      buildDirectory: path.join(process.cwd(), 'build'),
+      config,
+      fileCache,
+      headers: nextContext?.req?.headers,
+      logger: console,
+      nextContext,
+      req: nextContext?.req,
+      res: nextContext?.res,
+    };
+    try {
+      context.logger = createLogger({ rid: context.rid });
+      context.authOptions = getAuthOptions(context);
+      context.session = await getServerSession(context);
+      createApiContext(context);
+      logRequest({ context });
+      // Await here so that if handler throws it is caught.
+      const response = await handler({ context, nextContext });
+      return response;
+    } catch (error) {
+      logError({ error, context });
+      throw error;
+    }
+  };
+}
+
+export default serverSidePropsWrapper;

package/lowdefy/build.mjs

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 /*
-  Copyright 2020-2023 Lowdefy, Inc
+  Copyright 2020-2024 Lowdefy, Inc
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -16,6 +16,7 @@
 */
 
 import path from 'path';
+import pino from 'pino';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 
@@ -37,10 +38,23 @@ async function run() {
   };
 
   const customTypesMap = await createCustomPluginTypesMap({ directories });
+
+  const logger = pino({
+    name: 'lowdefy_build',
+    level: process.env.LOWDEFY_LOG_LEVEL ?? 'info',
+    base: { pid: undefined, hostname: undefined },
+    mixin: (context, level) => {
+      return {
+        ...context,
+        print: context.print ?? logger.levels.labels[level],
+      };
+    },
+  });
+
   await build({
     customTypesMap,
     directories,
-    logger: console,
+    logger,
     refResolver: argv.refResolver || process.env.LOWDEFY_BUILD_REF_RESOLVER,
   });
 }

package/lowdefy/createCustomPluginTypesMap.mjs

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 /*
-  Copyright 2020-2023 Lowdefy, Inc
+  Copyright 2020-2024 Lowdefy, Inc
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lowdefy/server",
-  "version": "4.0.0-rc.9",
+  "version": "4.5.0",
   "license": "Apache-2.0",
   "description": "",
   "homepage": "https://lowdefy.com",
@@ -35,47 +35,50 @@
     ".eslintrc.yaml",
     ".npmrc"
   ],
-  "scripts": {
-    "build": "cp package.json package.original.json || copy package.json package.original.json",
-    "build:lowdefy": "node lowdefy/build.mjs",
-    "build:next": "next build",
-    "dev": "next dev",
-    "start": "next start",
-    "lint": "next lint",
-    "next": "next"
-  },
   "dependencies": {
-    "@lowdefy/actions-core": "4.0.0-rc.9",
-    "@lowdefy/api": "4.0.0-rc.9",
-    "@lowdefy/blocks-antd": "4.0.0-rc.9",
-    "@lowdefy/blocks-basic": "4.0.0-rc.9",
-    "@lowdefy/blocks-loaders": "4.0.0-rc.9",
-    "@lowdefy/client": "4.0.0-rc.9",
-    "@lowdefy/helpers": "4.0.0-rc.9",
-    "@lowdefy/layout": "4.0.0-rc.9",
-    "@lowdefy/node-utils": "4.0.0-rc.9",
-    "@lowdefy/operators-js": "4.0.0-rc.9",
-    "@lowdefy/plugin-next-auth": "4.0.0-rc.9",
-    "next": "12.3.1",
-    "next-auth": "4.20.1",
+    "@lowdefy/actions-core": "4.5.0",
+    "@lowdefy/api": "4.5.0",
+    "@lowdefy/block-utils": "4.5.0",
+    "@lowdefy/blocks-antd": "4.5.0",
+    "@lowdefy/blocks-basic": "4.5.0",
+    "@lowdefy/blocks-loaders": "4.5.0",
+    "@lowdefy/client": "4.5.0",
+    "@lowdefy/helpers": "4.5.0",
+    "@lowdefy/layout": "4.5.0",
+    "@lowdefy/node-utils": "4.5.0",
+    "@lowdefy/operators-js": "4.5.0",
+    "@lowdefy/plugin-next-auth": "4.5.0",
+    "next": "13.5.4",
+    "next-auth": "4.24.5",
+    "pino": "8.16.2",
     "process": "0.11.10",
     "react": "18.2.0",
     "react-dom": "18.2.0",
-    "react-icons": "4.7.1"
+    "react-icons": "4.12.0"
   },
   "devDependencies": {
-    "@lowdefy/build": "4.0.0-rc.9",
-    "@next/eslint-plugin-next": "12.1.6",
-    "less": "4.1.3",
-    "less-loader": "11.1.0",
-    "next-with-less": "2.0.5",
-    "webpack": "5.76.0",
-    "yaml": "2.2.2",
-    "yargs": "17.6.2"
+    "@lowdefy/build": "4.5.0",
+    "@next/eslint-plugin-next": "13.5.4",
+    "less": "4.2.0",
+    "less-loader": "11.1.3",
+    "next-with-less": "3.0.1",
+    "webpack": "5.94.0",
+    "yaml": "2.3.4",
+    "yargs": "17.7.2"
+  },
+  "engines": {
+    "node": ">=18"
   },
-  "packageManager": "pnpm@7.11.0",
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d20e6ac424643feca527a732dc2b0710713c8243"
-}
+  "scripts": {
+    "build": "cp package.json package.original.json || copy package.json package.original.json",
+    "build:lowdefy": "node lowdefy/build.mjs",
+    "build:next": "next build",
+    "dev": "next dev",
+    "start": "next start",
+    "lint": "next lint",
+    "next": "next"
+  }
+}

package/package.original.json

@@ -1,6 +1,6 @@
 {
   "name": "@lowdefy/server",
-  "version": "4.0.0-rc.9",
+  "version": "4.5.0",
   "license": "Apache-2.0",
   "description": "",
   "homepage": "https://lowdefy.com",
@@ -42,38 +42,43 @@
     "dev": "next dev",
     "start": "next start",
     "lint": "next lint",
-    "next": "next"
+    "next": "next",
+    "prepublishOnly": "pnpm build"
   },
   "dependencies": {
-    "@lowdefy/actions-core": "4.0.0-rc.9",
-    "@lowdefy/api": "4.0.0-rc.9",
-    "@lowdefy/blocks-antd": "4.0.0-rc.9",
-    "@lowdefy/blocks-basic": "4.0.0-rc.9",
-    "@lowdefy/blocks-loaders": "4.0.0-rc.9",
-    "@lowdefy/client": "4.0.0-rc.9",
-    "@lowdefy/helpers": "4.0.0-rc.9",
-    "@lowdefy/layout": "4.0.0-rc.9",
-    "@lowdefy/node-utils": "4.0.0-rc.9",
-    "@lowdefy/operators-js": "4.0.0-rc.9",
-    "@lowdefy/plugin-next-auth": "4.0.0-rc.9",
-    "next": "12.3.1",
-    "next-auth": "4.20.1",
+    "@lowdefy/actions-core": "4.5.0",
+    "@lowdefy/api": "4.5.0",
+    "@lowdefy/block-utils": "4.5.0",
+    "@lowdefy/blocks-antd": "4.5.0",
+    "@lowdefy/blocks-basic": "4.5.0",
+    "@lowdefy/blocks-loaders": "4.5.0",
+    "@lowdefy/client": "4.5.0",
+    "@lowdefy/helpers": "4.5.0",
+    "@lowdefy/layout": "4.5.0",
+    "@lowdefy/node-utils": "4.5.0",
+    "@lowdefy/operators-js": "4.5.0",
+    "@lowdefy/plugin-next-auth": "4.5.0",
+    "next": "13.5.4",
+    "next-auth": "4.24.5",
+    "pino": "8.16.2",
     "process": "0.11.10",
     "react": "18.2.0",
     "react-dom": "18.2.0",
-    "react-icons": "4.7.1"
+    "react-icons": "4.12.0"
   },
   "devDependencies": {
-    "@lowdefy/build": "4.0.0-rc.9",
-    "@next/eslint-plugin-next": "12.1.6",
-    "less": "4.1.3",
-    "less-loader": "11.1.0",
-    "next-with-less": "2.0.5",
-    "webpack": "5.76.0",
-    "yaml": "2.2.2",
-    "yargs": "17.6.2"
+    "@lowdefy/build": "4.5.0",
+    "@next/eslint-plugin-next": "13.5.4",
+    "less": "4.2.0",
+    "less-loader": "11.1.3",
+    "next-with-less": "3.0.1",
+    "webpack": "5.94.0",
+    "yaml": "2.3.4",
+    "yargs": "17.7.2"
+  },
+  "engines": {
+    "node": ">=18"
   },
-  "packageManager": "pnpm@7.11.0",
   "publishConfig": {
     "access": "public"
   }

package/pages/404.js

@@ -1,5 +1,5 @@
 /*
-  Copyright 2020-2023 Lowdefy, Inc
+  Copyright 2020-2024 Lowdefy, Inc
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -13,25 +13,27 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 */
+
 import path from 'path';
 import { createApiContext, getPageConfig, getRootConfig } from '@lowdefy/api';
 
 import config from '../build/config.json';
-import fileCache from '../lib/fileCache.js';
-import Page from '../lib/Page.js';
+import fileCache from '../lib/server/fileCache.js';
+import Page from '../lib/client/Page.js';
 
 export async function getStaticProps() {
   // Important to give absolute path so Next can trace build files
-  const apiContext = createApiContext({
+  const context = {
     buildDirectory: path.join(process.cwd(), 'build'),
     config,
     fileCache,
-    logger: console,
-  });
+    logger: console, // TODO: pino or console or 🤷‍♂️?
+  };
+  createApiContext(context);
 
   const [rootConfig, pageConfig] = await Promise.all([
-    getRootConfig(apiContext),
-    getPageConfig(apiContext, { pageId: '404' }),
+    getRootConfig(context),
+    getPageConfig(context, { pageId: '404' }),
   ]);
 
   return {

package/pages/[pageId].js

@@ -1,5 +1,5 @@
 /*
-  Copyright 2020-2023 Lowdefy, Inc
+  Copyright 2020-2024 Lowdefy, Inc
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -14,32 +14,21 @@
   limitations under the License.
 */
 
-import path from 'path';
-import { createApiContext, getPageConfig, getRootConfig } from '@lowdefy/api';
-
-import config from '../build/config.json';
-import fileCache from '../lib/fileCache.js';
-import getServerSession from '../lib/auth/getServerSession.js';
-import Page from '../lib/Page.js';
-
-export async function getServerSideProps(context) {
-  const { pageId } = context.params;
-  const session = await getServerSession(context);
-  // Important to give absolute path so Next can trace build files
-  const apiContext = createApiContext({
-    buildDirectory: path.join(process.cwd(), 'build'),
-    config,
-    fileCache,
-    logger: console,
-    session,
-  });
+import { getPageConfig, getRootConfig } from '@lowdefy/api';
 
+import serverSidePropsWrapper from '../lib/server/serverSidePropsWrapper.js';
+import Page from '../lib/client/Page.js';
+
+async function getServerSidePropsHandler({ context, nextContext }) {
+  const { pageId } = nextContext.params;
+  const { logger, session } = context;
   const [rootConfig, pageConfig] = await Promise.all([
-    getRootConfig(apiContext),
-    getPageConfig(apiContext, { pageId }),
+    getRootConfig(context),
+    getPageConfig(context, { pageId }),
   ]);
 
   if (!pageConfig) {
+    logger.info({ event: 'redirect_page_not_found', pageId });
     return {
       redirect: {
         destination: '/404',
@@ -47,7 +36,7 @@ export async function getServerSideProps(context) {
       },
     };
   }
-
+  logger.info({ event: 'page_view', pageId });
   return {
     props: {
       pageConfig,
@@ -57,4 +46,6 @@ export async function getServerSideProps(context) {
   };
 }
 
+export const getServerSideProps = serverSidePropsWrapper(getServerSidePropsHandler);
+
 export default Page;