@lowdefy/server-dev 4.0.0-alpha.9 → 4.0.0-rc.1

package/.npmrc

@@ -0,0 +1 @@
+strict-peer-dependencies=false

package/lib/App.js

@@ -0,0 +1,67 @@
+/*
+  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 React from 'react';
+
+import { useRouter } from 'next/router';
+
+import Head from 'next/head';
+import Link from 'next/link';
+
+import Reload from './Reload.js';
+import Page from './Page.js';
+import setPageId from './setPageId.js';
+import useRootConfig from './utils/useRootConfig.js';
+
+import actions from '../build/plugins/actions.js';
+import blocks from '../build/plugins/blocks.js';
+import icons from '../build/plugins/icons.js';
+import operators from '../build/plugins/operators/client.js';
+
+const App = ({ auth }) => {
+  const router = useRouter();
+  const { data: rootConfig } = useRootConfig(router.basePath);
+
+  const { redirect, pageId } = setPageId(router, rootConfig);
+  if (redirect) {
+    router.push(`/${pageId}`);
+    return '';
+  }
+  return (
+    <Reload basePath={router.basePath}>
+      {(resetContext) => (
+        <Page
+          auth={auth}
+          Components={{ Head, Link }}
+          config={{
+            rootConfig,
+          }}
+          pageId={pageId}
+          resetContext={resetContext}
+          router={router}
+          types={{
+            actions,
+            blocks,
+            icons,
+            operators,
+          }}
+        />
+      )}
+    </Reload>
+  );
+};
+
+export default App;

package/lib/Page.js

@@ -0,0 +1,50 @@
+/*
+  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 React from 'react';
+import Client from '@lowdefy/client';
+
+import RestartingPage from './RestartingPage.js';
+import usePageConfig from './utils/usePageConfig.js';
+
+const Page = ({ auth, Components, config, pageId, resetContext, router, types }) => {
+  const { data: pageConfig } = usePageConfig(pageId, router.basePath);
+
+  if (!pageConfig) {
+    router.replace(`/404`);
+    return '';
+  }
+  if (resetContext.restarting) {
+    return <RestartingPage />;
+  }
+  return (
+    <Client
+      auth={auth}
+      Components={Components}
+      config={{
+        ...config,
+        pageConfig,
+      }}
+      resetContext={resetContext}
+      router={router}
+      stage="dev"
+      types={types}
+      window={window}
+    />
+  );
+};
+
+export default Page;

package/lib/Reload.js

@@ -0,0 +1,52 @@
+/*
+  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 React, { useEffect, useState } from 'react';
+
+import useMutateCache from './utils/useMutateCache.js';
+import waitForRestartedServer from './utils/waitForRestartedServer.js';
+
+const Reload = ({ children, basePath }) => {
+  const [reset, setReset] = useState(false);
+  const [restarting, setRestarting] = useState(false);
+  const mutateCache = useMutateCache(basePath);
+  useEffect(() => {
+    const sse = new EventSource(`${basePath}/api/reload`);
+
+    sse.addEventListener('reload', () => {
+      // add a update delay to prevent rerender before server is shut down for rebuild, ideally we don't want to do this.
+      // TODO: We need to pass a flag when a rebuild will happen so that client does not trigger render.
+      setTimeout(async () => {
+        await mutateCache();
+        setReset(true);
+        console.log('Reloaded config.');
+      }, 600);
+    });
+
+    sse.onerror = () => {
+      setRestarting(true);
+      console.log('Rebuilding Lowdefy App.');
+      sse.close();
+      waitForRestartedServer(basePath);
+    };
+    return () => {
+      sse.close();
+    };
+  }, []);
+  return <>{children({ reset, setReset, restarting })}</>;
+};
+
+export default Reload;

package/lib/RestartingPage.js

@@ -0,0 +1,47 @@
+/*
+  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 React from 'react';
+
+const RestartingPage = () => {
+  return (
+    <div
+      style={{
+        height: '100vh',
+        textAlign: 'center',
+        display: 'flex',
+        flexDirection: 'column',
+        alignItems: 'center',
+        justifyContent: 'center',
+      }}
+    >
+      <div
+        style={{
+          verticalAlign: 'middle',
+          display: 'inline-block',
+        }}
+      >
+        <h3>Rebuilding Lowdefy App</h3>
+        <p>
+          The server is restarting because your configuration changed. The page will reload when
+          ready.
+        </p>
+      </div>
+    </div>
+  );
+};
+
+export default RestartingPage;

package/lib/auth/Auth.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.
+*/
+/* eslint-disable react/jsx-props-no-spreading */
+
+import React from 'react';
+import AuthConfigured from './AuthConfigured.js';
+import AuthNotConfigured from './AuthNotConfigured.js';
+
+import authConfig from '../../build/auth.json';
+
+function Auth({ children, session }) {
+  if (authConfig.configured === true) {
+    return (
+      <AuthConfigured session={session} authConfig={authConfig}>
+        {(auth) => children(auth)}
+      </AuthConfigured>
+    );
+  }
+  return <AuthNotConfigured authConfig={authConfig}>{(auth) => children(auth)}</AuthNotConfigured>;
+}
+
+export default Auth;

package/lib/auth/AuthConfigured.js

@@ -0,0 +1,47 @@
+/*
+  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.
+*/
+/* eslint-disable react/jsx-props-no-spreading */
+
+import React from 'react';
+import { SessionProvider, signIn, signOut, useSession } from 'next-auth/react';
+
+function Session({ children }) {
+  const { data: session, status } = useSession();
+  // If session is passed to SessionProvider from getServerSideProps
+  // we won't have a loading state here.
+  // But 404 uses getStaticProps so we have this for 404.
+  if (status === 'loading') {
+    return '';
+  }
+  return children(session);
+}
+
+function AuthConfigured({ authConfig, children, serverSession }) {
+  const auth = { signIn, signOut, authConfig };
+
+  return (
+    <SessionProvider session={serverSession}>
+      <Session>
+        {(session) => {
+          auth.session = session;
+          return children(auth);
+        }}
+      </Session>
+    </SessionProvider>
+  );
+}
+
+export default AuthConfigured;

package/lib/auth/AuthNotConfigured.js

@@ -0,0 +1,32 @@
+/*
+  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.
+*/
+/* eslint-disable react/jsx-props-no-spreading */
+
+function authNotConfigured() {
+  throw new Error('Auth not configured.');
+}
+
+function AuthNotConfigured({ authConfig, children }) {
+  const auth = {
+    authConfig,
+    signIn: authNotConfigured,
+    signOut: authNotConfigured,
+  };
+
+  return children(auth);
+}
+
+export default AuthNotConfigured;

package/lib/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 { unstable_getServerSession } from 'next-auth/next';
+import { authOptions } from '../../pages/api/auth/[...nextauth].js';
+import authJson from '../../build/auth.json';
+
+async function getServerSession({ req, res }) {
+  if (authJson.configured === true) {
+    return await unstable_getServerSession(req, res, authOptions);
+  }
+  return undefined;
+}
+
+export default getServerSession;

package/lib/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/setPageId.js

@@ -0,0 +1,30 @@
+/*
+  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 setPageId(router, rootConfig) {
+  if (router.pathname === `/404`) {
+    return { redirect: false, pageId: '404' };
+  }
+  if (!router.query.pageId) {
+    if (rootConfig.home.configured === false) {
+      return { redirect: true, pageId: rootConfig.home.pageId };
+    }
+    return { redirect: false, pageId: rootConfig.home.pageId };
+  }
+  return { redirect: false, pageId: router.query.pageId };
+}
+
+export default setPageId;

package/lib/utils/request.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.
+*/
+
+async function request({ url, method = 'GET', body }) {
+  const res = await fetch(url, {
+    method,
+    headers: {
+      'Content-Type': 'application/json',
+    },
+    body: body && JSON.stringify(body),
+  });
+  if (res.status === 404) {
+    return null;
+  }
+  if (!res.ok) {
+    // TODO: check
+    const body = await res.json();
+    console.log(res);
+    console.log(body);
+    throw new Error(body.message || 'Request error');
+  }
+  return res.json();
+}
+
+export default request;

package/lib/utils/useMutateCache.js

@@ -0,0 +1,25 @@
+/*
+  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 { useSWRConfig } from 'swr';
+
+function useMutateCache(basePath) {
+  const { mutate } = useSWRConfig();
+  return () =>
+    mutate((key) => key.startsWith(`${basePath}/api/page`) || key === `${basePath}/api/root`);
+}
+
+export default useMutateCache;

package/lib/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/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/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/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;