@lowdefy/server-dev 0.0.0-alpha.7 → 0.0.0-experimental-20231123101256

package/lib/client/utils/usePageConfig.js

@@ -0,0 +1,27 @@
+/*
+  Copyright 2020-2023 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 useSWR from 'swr';
+
+import request from './request.js';
+
+function fetchPageConfig(url) {
+  return request({ url });
+}
+
+function usePageConfig(pageId, basePath) {
+  const { data } = useSWR(`${basePath}/api/page/${pageId}`, fetchPageConfig, { suspense: true });
+  return { data };
+}
+
+export default usePageConfig;

package/lib/client/utils/useRootConfig.js

@@ -0,0 +1,26 @@
+/*
+  Copyright 2020-2023 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 useSWR from 'swr';
+import request from './request.js';
+
+function fetchRootConfig(url) {
+  return request({ url });
+}
+
+function useRootConfig(basePath) {
+  const { data } = useSWR(`${basePath}/api/root`, fetchRootConfig, { suspense: true });
+  return { data };
+}
+
+export default useRootConfig;

package/lib/client/utils/waitForRestartedServer.js

@@ -0,0 +1,38 @@
+/*
+  Copyright 2020-2023 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 request from './request.js';
+
+const MAX_COUNT = 1200; // 10 mins
+
+function waitForRestartedServer(basePath) {
+  let count = 0;
+  setTimeout(async () => {
+    try {
+      await request({
+        url: `${basePath}/api/ping`,
+      });
+      window.location.reload();
+    } catch (error) {
+      count += 1;
+      if (count <= MAX_COUNT) {
+        waitForRestartedServer(basePath);
+      }
+    }
+  }, 500); // TODO: this ping should be shorter than rerender delay until we can pass a rebuild flag to reload.
+}
+
+export default waitForRestartedServer;

package/lib/server/apiWrapper.js

@@ -0,0 +1,68 @@
+/*
+  Copyright 2020-2023 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 { getSecretsFromEnv } from '@lowdefy/node-utils';
+
+import config from '../../build/config.json';
+import connections from '../../build/plugins/connections.js';
+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 operators from '../../build/plugins/operators/server.js';
+import getAuthOptions from './auth/getAuthOptions.js';
+
+const secrets = getSecretsFromEnv();
+
+function apiWrapper(handler) {
+  return async function wrappedHandler(req, res) {
+    const context = {
+      // Important to give absolute path so Next can trace build files
+      rid: crypto.randomUUID(),
+      buildDirectory: path.join(process.cwd(), 'build'),
+      config,
+      connections,
+      fileCache,
+      headers: req?.headers,
+      logger: console,
+      operators,
+      req,
+      res,
+      secrets,
+    };
+    try {
+      context.logger = createLogger({ rid: context.rid });
+      context.authOptions = getAuthOptions(context);
+      if (!req.url.startsWith('/api/auth')) {
+        context.session = await getServerSession(context);
+      }
+      createApiContext(context);
+      logRequest({ context });
+      // Await here so that if handler throws it is caught.
+      const response = await handler({ context, req, res });
+      // TODO: Log response time?
+      return response;
+    } catch (error) {
+      logError({ error, context });
+      res.status(500).json({ name: error.name, message: error.message });
+    }
+  };
+}
+
+export default apiWrapper;

package/lib/server/auth/getAuthOptions.js

@@ -0,0 +1,35 @@
+/*
+  Copyright 2020-2023 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/server/auth/getServerSession.js

@@ -0,0 +1,28 @@
+/*
+  Copyright 2020-2023 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 { getServerSession as getNextAuthServerSession } from 'next-auth/next';
+
+import authJson from '../../../build/auth.json';
+
+function getServerSession({ authOptions, req, res }) {
+  if (authJson.configured === true) {
+    return getNextAuthServerSession(req, res, authOptions);
+  }
+  return undefined;
+}
+
+export default getServerSession;

package/lib/server/fileCache.js

@@ -0,0 +1,20 @@
+/*
+  Copyright 2020-2023 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.
+*/
+
+export default {
+  get: () => undefined,
+  set: () => undefined,
+};

package/lib/server/log/createLogger.js

@@ -0,0 +1,29 @@
+/*
+  Copyright 2020-2023 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';
+
+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,40 @@
+/*
+  Copyright 2020-2023 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 { user = {} } = context;
+
+    context.logger.error({
+      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,
+    });
+  } 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,33 @@
+/*
+  Copyright 2020-2023 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 { user = {} } = context;
+  context.logger.debug({
+    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,
+  });
+}
+
+export default logRequest;

package/manager/getContext.mjs

@@ -0,0 +1,77 @@
+/*
+  Copyright 2020-2023 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 yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+
+import createLogger from './utils/createLogger.mjs';
+import initialBuild from './processes/initialBuild.mjs';
+import installPlugins from './processes/installPlugins.mjs';
+import lowdefyBuild from './processes/lowdefyBuild.mjs';
+import nextBuild from './processes/nextBuild.mjs';
+import readDotEnv from './processes/readDotEnv.mjs';
+import reloadClients from './processes/reloadClients.mjs';
+import restartServer from './processes/restartServer.mjs';
+import shutdownServer from './processes/shutdownServer.mjs';
+import startWatchers from './processes/startWatchers.mjs';
+
+import getNextBin from './utils/getNextBin.mjs';
+
+const argv = yargs(hideBin(process.argv)).array('watch').array('watchIgnore').argv;
+
+async function getContext() {
+  const env = process.env;
+
+  const context = {
+    bin: {
+      next: getNextBin(),
+    },
+    directories: {
+      build: path.resolve(process.cwd(), './build'),
+      config: path.resolve(argv.configDirectory || env.LOWDEFY_DIRECTORY_CONFIG || process.cwd()),
+      server: process.cwd(),
+    },
+    logger: createLogger({ level: env.LOWDEFY_LOG_LEVEL }),
+    options: {
+      port: argv.port || env.PORT || 3000,
+      refResolver: argv.refResolver || env.LOWDEFY_BUILD_REF_RESOLVER,
+      watch:
+        argv.watch || env.LOWDEFY_SERVER_DEV_WATCH ? JSON.parse(env.LOWDEFY_SERVER_DEV_WATCH) : [],
+      watchIgnore:
+        argv.watchIgnore || env.LOWDEFY_SERVER_DEV_WATCH_IGNORE
+          ? JSON.parse(env.LOWDEFY_SERVER_DEV_WATCH_IGNORE)
+          : [],
+    },
+    version: env.npm_package_version,
+  };
+
+  context.packageManagerCmd = process.platform === 'win32' ? 'pnpm.cmd' : 'pnpm';
+  context.initialBuild = initialBuild(context);
+  context.installPlugins = installPlugins(context);
+  context.lowdefyBuild = lowdefyBuild(context);
+  context.nextBuild = nextBuild(context);
+  context.readDotEnv = readDotEnv(context);
+  context.reloadClients = reloadClients(context);
+  context.restartServer = restartServer(context);
+  context.shutdownServer = shutdownServer(context);
+  context.startWatchers = startWatchers(context);
+
+  return context;
+}
+
+export default getContext;

package/manager/processes/initialBuild.mjs

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+/*
+  Copyright 2020-2023 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 initialBuild(context) {
+  return async () => {
+    context.readDotEnv();
+    await context.lowdefyBuild();
+    await context.installPlugins();
+    await context.nextBuild();
+  };
+}
+
+export default initialBuild;

package/manager/processes/installPlugins.mjs

@@ -0,0 +1,31 @@
+/*
+  Copyright 2020-2023 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 { spawnProcess } from '@lowdefy/node-utils';
+
+function installPlugins({ logger, packageManagerCmd }) {
+  return async () => {
+    logger.info({ print: 'spin' }, 'Installing plugins...');
+    await spawnProcess({
+      command: packageManagerCmd,
+      args: ['install', '--no-frozen-lockfile'],
+      stdOutLineHandler: (line) => logger.debug(line),
+    });
+    logger.info({ print: 'log' }, 'Installed plugins.');
+  };
+}
+
+export default installPlugins;

package/manager/processes/lowdefyBuild.mjs

@@ -0,0 +1,35 @@
+/*
+  Copyright 2020-2023 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 build from '@lowdefy/build';
+import createCustomPluginTypesMap from '../utils/createCustomPluginTypesMap.mjs';
+
+function lowdefyBuild({ directories, logger, options }) {
+  return async () => {
+    logger.info({ print: 'spin' }, 'Building config...');
+    const customTypesMap = await createCustomPluginTypesMap({ directories, logger });
+    await build({
+      customTypesMap,
+      directories,
+      logger,
+      refResolver: options.refResolver,
+      stage: 'dev',
+    });
+    logger.info({ print: 'log' }, 'Built config.');
+  };
+}
+
+export default lowdefyBuild;

package/manager/processes/nextBuild.mjs

@@ -0,0 +1,31 @@
+/*
+  Copyright 2020-2023 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 { spawnProcess } from '@lowdefy/node-utils';
+
+function nextBuild({ bin, logger }) {
+  return async () => {
+    logger.info({ print: 'spin' }, 'Building app...');
+    await spawnProcess({
+      command: 'node',
+      args: [bin.next, 'build'],
+      stdOutLineHandler: (line) => logger.debug(line),
+    });
+    logger.info({ print: 'log' }, 'Built app.');
+  };
+}
+
+export default nextBuild;

package/manager/processes/readDotEnv.mjs

@@ -0,0 +1,26 @@
+/*
+  Copyright 2020-2023 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 dotenv from 'dotenv';
+
+function readDotEnv(context) {
+  return () => {
+    dotenv.config({ path: path.join(context.directories.config, '.env'), silent: true });
+  };
+}
+
+export default readDotEnv;

package/manager/processes/reloadClients.mjs

@@ -0,0 +1,26 @@
+/*
+  Copyright 2020-2023 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 { writeFile } from '@lowdefy/node-utils';
+
+function reloadClients({ directories }) {
+  return async () => {
+    await writeFile(path.join(directories.build, 'reload'), `${Date.now()}`);
+  };
+}
+
+export default reloadClients;

package/manager/processes/restartServer.mjs

@@ -0,0 +1,28 @@
+/*
+  Copyright 2020-2023 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 startServer from './startServer.mjs';
+
+function restartServer(context) {
+  return () => {
+    context.shutdownServer();
+    context.logger.info({ print: 'spin' }, 'Restarting server...');
+    startServer(context);
+    context.logger.info({ print: 'succeed' }, 'Restarted server.');
+  };
+}
+
+export default restartServer;

package/manager/processes/shutdownServer.mjs

@@ -0,0 +1,35 @@
+/*
+  Copyright 2020-2023 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 shutdownServer(context) {
+  return () => {
+    if (context.nextServer) {
+      context.logger.debug(
+        `Existing next server with pid ${context.nextServer.pid}, killed: ${context.nextServer.killed}`
+      );
+      if (!context.nextServer.killed) {
+        context.logger.info({ print: 'spin' }, 'Shutting down server...');
+        context.nextServer.kill();
+        context.logger.debug(
+          `Killed next server with pid ${context.nextServer.pid}, killed: ${context.nextServer.killed}`
+        );
+      }
+      context.nextServer = null;
+    }
+  };
+}
+
+export default shutdownServer;