@lowdefy/server-dev 3.23.1 → 4.0.0-alpha.10

package/.eslintrc.yaml

@@ -0,0 +1 @@
+extends: 'plugin:@next/next/core-web-vitals'

package/README.md

@@ -1,29 +1,5 @@
 # @lowdefy/server-dev
 
-A Lowdefy server for local development.
-
-The server consists of a Lowdefy Graphql server, and a static file server to serve the web client shell. The web shell is a minimal react app, that loads a Lowdefy renderer using [webpack module federation](https://webpack.js.org/concepts/module-federation/).
-
-> If you wish to develop a Lowdefy app, use the development server in the [CLI](https://docs.lowdefy.com/cli). The code for the CLI can be found [here](https://github.com/lowdefy/lowdefy/tree/main/packages/cli)
-
-## Running a development server
-
-- Build the repository in development mode by running `yarn build:dev` at the root of the repository.
-- Create a `lowdefy.yaml` file in the root of the package directory, and build this configuration with the cli using `lowdefy build`.
-- Build the dev server using `yarn build`.
-- Run the dev server using `yarn start`.
-- Run a [`@lowdefy/renderer`](https://github.com/lowdefy/lowdefy/tree/main/packages/renderer) server at port 3001 using `yarn start` or `yarn serve`.
-
-To make changes to the server, you need to run `yarn build` in dependencies that have changed (like `@lowdefy/graphql`), and then run `yarn build`.
-
-## More Lowdefy resources
-
-- Getting started with Lowdefy - https://docs.lowdefy.com/tutorial-start
-- Lowdefy docs - https://docs.lowdefy.com
-- Lowdefy website - https://lowdefy.com
-- Community forum - https://github.com/lowdefy/lowdefy/discussions
-- Bug reports and feature requests - https://github.com/lowdefy/lowdefy/issues
-
 ## Licence
 
 [Apache-2.0](https://github.com/lowdefy/lowdefy/blob/main/LICENSE)

package/lib/App.js

@@ -0,0 +1,66 @@
+/*
+  Copyright 2020-2022 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/operatorsClient.js';
+
+const App = () => {
+  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
+          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,48 @@
+/*
+  Copyright 2020-2022 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 = ({ 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
+      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-2022 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-2022 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/setPageId.js

@@ -0,0 +1,30 @@
+/*
+  Copyright 2020-2022 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-2022 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,34 @@
+/*
+  Copyright 2020-2022 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 { cache, mutate } = useSWRConfig();
+  return () => {
+    const keys = [`${basePath}/api/root`];
+
+    for (const key of cache.keys()) {
+      if (key.startsWith(`${basePath}/api/page`)) {
+        keys.push(key);
+      }
+    }
+    const mutations = keys.map((key) => mutate(key));
+    return Promise.all(mutations);
+  };
+}
+
+export default useMutateCache;

package/lib/utils/usePageConfig.js

@@ -0,0 +1,29 @@
+/*
+  Copyright 2020-2022 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';
+
+// TODO: Handle TokenExpiredError
+
+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,29 @@
+/*
+  Copyright 2020-2022 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';
+
+// TODO: Handle TokenExpiredError
+
+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,32 @@
+/*
+  Copyright 2020-2022 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';
+
+function waitForRestartedServer(basePath) {
+  setTimeout(async () => {
+    try {
+      await request({
+        url: `${basePath}/api/ping`,
+      });
+      window.location.reload();
+    } catch (error) {
+      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,81 @@
+/*
+  Copyright 2020-2022 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 no-console */
+
+import path from 'path';
+import { createRequire } from 'module';
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+
+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';
+
+const argv = yargs(hideBin(process.argv)).array('watch').array('watchIgnore').argv;
+const require = createRequire(import.meta.url);
+
+async function getContext() {
+  const env = process.env;
+
+  const nextPageJson = require('next/package.json');
+  const context = {
+    bin: {
+      next: path.join(
+        require.resolve('next').replace(nextPageJson.main.substring(1), ''),
+        nextPageJson.bin.next
+      ),
+    },
+    directories: {
+      build: path.resolve(process.cwd(), './build'),
+      config: path.resolve(argv.configDirectory || env.LOWDEFY_DIRECTORY_CONFIG || process.cwd()),
+      server: process.cwd(),
+    },
+    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)
+          : [],
+      // TODO: read option from env
+      verbose: argv.verbose || false,
+    },
+    packageManager: argv.packageManager || env.LOWDEFY_PACKAGE_MANAGER || 'npm',
+    version: env.npm_package_version,
+  };
+
+  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-2022 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 () => {
+    await context.lowdefyBuild();
+    await context.installPlugins();
+    await context.nextBuild();
+    await context.readDotEnv();
+  };
+}
+
+export default initialBuild;

package/manager/processes/installPlugins.mjs

@@ -0,0 +1,36 @@
+/*
+  Copyright 2020-2022 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';
+
+const args = {
+  npm: ['install', '--legacy-peer-deps'],
+  yarn: ['install'],
+};
+
+function installPlugins({ packageManager, options }) {
+  return async () => {
+    console.log('Installing plugins...');
+    await spawnProcess({
+      logger: console,
+      command: packageManager, // npm or yarn
+      args: args[packageManager],
+      silent: !options.verbose,
+    });
+  };
+}
+
+export default installPlugins;

package/manager/processes/lowdefyBuild.mjs

@@ -0,0 +1,32 @@
+/*
+  Copyright 2020-2022 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, options }) {
+  return async () => {
+    const customTypesMap = await createCustomPluginTypesMap({ directories });
+    await build({
+      customTypesMap,
+      directories,
+      logger: console,
+      refResolver: options.refResolver,
+    });
+  };
+}
+
+export default lowdefyBuild;

package/manager/processes/nextBuild.mjs

@@ -0,0 +1,31 @@
+/*
+  Copyright 2020-2022 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, options }) {
+  return async () => {
+    console.log('Building app...');
+    await spawnProcess({
+      logger: console,
+      command: 'node',
+      args: [bin.next, 'build'],
+      silent: !options.verbose,
+    });
+  };
+}
+
+export default nextBuild;