@geode/opengeodeweb-front 10.34.0 → 10.35.0-rc.2

package/.build/opengeodeweb_front_schemas.js

@@ -160,16 +160,7 @@ var api = {
 			"required": ["extension", "platform"],
 			"additionalProperties": false
 		} }
-	},
-	"serverless": { "run_cloud": {
-		"$id": "api/serverless/run_cloud",
-		"route": "/run_cloud",
-		"methods": ["POST"],
-		"type": "object",
-		"properties": { "email": { "type": "string" } },
-		"required": ["email"],
-		"additionalProperties": false
-	} }
+	}
 };
 //#endregion
 export { api };

package/.build/server/utils/cloud.js

@@ -1,77 +1,8 @@
 import path from "node:path";
 import fs from "node:fs";
 import { execFileSync } from "node:child_process";
-import { google } from "googleapis";
 //#region server/utils/cloud.ts
 const LOCATIONS_DIR = "/etc/nginx/locations";
-async function artifactImage(parent, authClient) {
-	const projectName = process.env.PROJECT;
-	const registry = google.artifactregistry({
-		version: "v1",
-		auth: authClient
-	});
-	const branch = process.env.NETLIFY_BRANCH;
-	const [, projectId] = parent.split("/");
-	const name = `${`${parent}/repositories/github/packages/`}${projectName}/tags/${branch}`;
-	console.log({ name });
-	const response = await registry.projects.locations.repositories.packages.tags.get({ name });
-	console.log({ response });
-	const digest = (response.data.version ?? "").split("/").pop();
-	const image = `${`europe-west9-docker.pkg.dev/${projectId}/github`}/${projectName}@${digest}`;
-	console.log("Found image for", projectName, image);
-	return image;
-}
-function sanitizeLabelValue(label) {
-	console.log("label", label);
-	return label.toLowerCase().replaceAll(/[^a-z0-9_-]/gu, "_").slice(0, 63);
-}
-function requestConfig(parent, image, email, projectName) {
-	const resources = {
-		limits: {
-			cpu: "2000m",
-			memory: "3Gi"
-		},
-		cpuIdle: false,
-		startupCpuBoost: true
-	};
-	const labels = {
-		user: sanitizeLabelValue(email),
-		project: sanitizeLabelValue(projectName)
-	};
-	return {
-		parent,
-		service: {
-			ingress: "INGRESS_TRAFFIC_ALL",
-			invokerIamDisabled: true,
-			labels,
-			scaling: {
-				scalingMode: "MANUAL",
-				manualInstanceCount: 1
-			},
-			template: {
-				labels,
-				timeout: { seconds: 3600 },
-				containers: [{
-					image,
-					ports: [{ containerPort: 80 }],
-					resources,
-					env: [{
-						name: "PARENT",
-						value: parent
-					}],
-					startupProbe: {
-						httpGet: {
-							port: 80,
-							path: "/viewer/healthcheck"
-						},
-						periodSeconds: 1,
-						failureThreshold: 30
-					}
-				}]
-			}
-		}
-	};
-}
 function addSupervisorProgram(name, command, executableArgs) {
 	const conf = `
 [program:${name}]
@@ -153,4 +84,4 @@ function removeNginxLocation(name) {
 	return true;
 }
 //#endregion
-export { addNginxLocation, addSupervisorProgram, artifactImage, removeNginxLocation, requestConfig };
+export { addNginxLocation, addSupervisorProgram, removeNginxLocation };

package/app/stores/api.ts

@@ -0,0 +1,68 @@
+import type { RequestHandlers } from "@ogw_shared/utils/types";
+import { api_fetch } from "@ogw_internal/utils/api_fetch";
+
+interface ApiSchema {
+  $id: string;
+  methods: string[];
+  [key: string]: unknown;
+}
+
+type ApiCallbacks = RequestHandlers & {
+  skip_feedback_error?: boolean;
+};
+
+const MILLISECONDS_IN_SECOND = 1000;
+
+export const useAPIStore = defineStore("api", () => {
+  const request_counter = ref(0);
+  const base_url = ref(useRuntimeConfig().public.CLOUD_API_URL);
+
+  function start_request(): void {
+    request_counter.value += 1;
+  }
+
+  function stop_request(): void {
+    request_counter.value -= 1;
+  }
+
+  // `TResult` is asserted, not verified: the response is only checked against `schema` at runtime
+  async function request<TResult = unknown>(
+    {
+      schema,
+      params = {},
+      headers = {},
+    }: { schema: ApiSchema; params?: Record<string, unknown>; headers?: Record<string, string> },
+    callbacks: ApiCallbacks = {},
+  ): Promise<TResult> {
+    console.log("[API] Request:", schema.$id);
+    const start = Date.now();
+
+    const result = await api_fetch(
+      { $id: schema.$id, base_url: base_url.value, start_request, stop_request },
+      { schema, params, headers },
+      {
+        ...callbacks,
+        response_function: async (response: unknown) => {
+          console.log(
+            "[API] Request completed:",
+            schema.$id,
+            "in",
+            (Date.now() - start) / MILLISECONDS_IN_SECOND,
+            "s",
+          );
+          if (callbacks.response_function) {
+            await callbacks.response_function(response);
+          }
+        },
+      },
+    );
+    // oxlint-disable-next-line no-unsafe-type-assertion -- trusted API boundary; see comment above.
+    return result as TResult;
+  }
+  return {
+    base_url,
+    request,
+    start_request,
+    stop_request,
+  };
+});

package/app/stores/cloud.ts

@@ -1,8 +1,19 @@
 import { Status } from "@ogw_front/utils/status";
-import { fetchSchema } from "@ogw_shared/utils/fetch_schema";
 import { setAppBaseUrl } from "@ogw_shared/scripts";
+import { useAPIStore } from "@ogw_front/stores/api";
 
-import opengeodeweb_front_schemas from "@geode/opengeodeweb-front/opengeodeweb_front_schemas.json" with { type: "json" };
+const run_cloud_schema = {
+  $id: "/cloud/run",
+  methods: ["POST"],
+  type: "object",
+  properties: {
+    email: { type: "string" },
+    project: { type: "string" },
+    branch: { type: "string" },
+  },
+  required: ["email", "project", "branch"],
+  additionalProperties: false,
+};
 
 export const useCloudStore = defineStore("cloud", {
   state: () => ({
@@ -11,14 +22,15 @@ export const useCloudStore = defineStore("cloud", {
   actions: {
     async launch(email: string) {
       this.status = Status.CONNECTING;
-      const schema = opengeodeweb_front_schemas.api.serverless.run_cloud;
-      const params = { email };
+      const { PROJECT, BRANCH } = useRuntimeConfig().public;
+      const params = { email, project: PROJECT, branch: BRANCH };
       const { useAppStore } = await import("./app");
       const { useFeedbackStore } = await import("./feedback");
       const appStore = useAppStore();
       const feedbackStore = useFeedbackStore();
-      const result = await fetchSchema(
-        { schema, params },
+      const APIStore = useAPIStore();
+      const result = await APIStore.request(
+        { schema: run_cloud_schema, params },
         {
           request_error_function: () => {
             feedbackStore.$patch({ server_error: true });

package/internal/utils/api_fetch.ts

@@ -83,7 +83,7 @@ async function api_fetch(
       timeout,
     },
     {
-      request_error_function(error: unknown) {
+      async request_error_function(error: unknown) {
         microservice.stop_request();
         const typedError = toFetchErrorLike(error);
         if (skip_feedback_error !== true) {
@@ -95,17 +95,17 @@ async function api_fetch(
           );
         }
         if (request_error_function) {
-          void request_error_function(error);
+          await request_error_function(error);
         }
       },
-      response_function(data: unknown) {
+      async response_function(data: unknown) {
         endRequestLog(microservice, schema, requestStartingTime);
         microservice.stop_request();
         if (response_function) {
-          response_function(data);
+          await response_function(data);
         }
       },
-      response_error_function(response: unknown) {
+      async response_error_function(response: unknown) {
         microservice.stop_request();
         const typedResponse = toFetchErrorResponseLike(response);
         if (skip_feedback_error !== true) {
@@ -117,7 +117,7 @@ async function api_fetch(
           );
         }
         if (response_error_function) {
-          void response_error_function(response);
+          await response_error_function(response);
         }
       },
       validation_error_function({ code, name, error }) {

package/nuxt.config.ts

@@ -4,12 +4,57 @@ import path from "node:path";
 
 // Third party imports
 import { defineNuxtConfig } from "nuxt/config";
+import type { Nuxt } from "nuxt/schema";
 
 // Local imports
-import package_json from "./package.json";
 
 const __dirname = import.meta.dirname;
 
+const CLOUD_API_BASE_URL = "https://europe-west9-project-98b129be-91e9-491b-8ce.cloudfunctions.net";
+const RELEASE_VERSION_REGEX = /^\d+\.\d+\.\d+$/u;
+
+// Master builds ("latest" on cloud/docker, plain semver on desktop) target the
+// Production api; next builds ("next", "x.y.z-rc.n") and local dev ("0.0.0")
+// Target api-next.
+function cloudApiUrl(version: string): string {
+  const is_master =
+    version === "latest" || (RELEASE_VERSION_REGEX.test(version) && version !== "0.0.0");
+  return `${CLOUD_API_BASE_URL}/${is_master ? "api" : "api-next"}`;
+}
+
+function isUnset(value: unknown): boolean {
+  return typeof value !== "string" || value === "";
+}
+
+function readAppPackage(root_dir: string): { name: string; version: string } {
+  const app_package: unknown = JSON.parse(
+    fs.readFileSync(path.join(root_dir, "package.json"), "utf8"),
+  );
+  if (typeof app_package !== "object" || app_package === null) {
+    return { name: "", version: "0.0.0" };
+  }
+  return {
+    name: "name" in app_package && typeof app_package.name === "string" ? app_package.name : "",
+    version:
+      "version" in app_package && typeof app_package.version === "string"
+        ? app_package.version
+        : "0.0.0",
+  };
+}
+
+// This file is also loaded as a layer, where ./package.json is the layer's own: the app's
+// Package is only reachable from a module, once nuxt.options.rootDir points at the app.
+function setAppPackageConfig(_options: unknown, nuxt: Nuxt): void {
+  const config = nuxt.options.runtimeConfig.public;
+  const { name, version } = readAppPackage(nuxt.options.rootDir);
+  if (isUnset(config.PROJECT)) {
+    config.PROJECT = name;
+  }
+  if (isUnset(config.CLOUD_API_URL)) {
+    config.CLOUD_API_URL = cloudApiUrl(version);
+  }
+}
+
 // Oxlint's type-aware linter auto-discovers each file's nearest tsconfig.json
 // By walking up directories, and any "extends" on that discovered file makes
 // Its whole type-aware resolution collapse: every symbol coming through the
@@ -41,7 +86,9 @@ export default defineNuxtConfig({
       COMMAND_VIEWER: "opengeodeweb-viewer",
       NUXT_ROOT_PATH: __dirname,
       MODE: process.env.MODE ?? "CLOUD",
-      PROJECT: package_json.name,
+      PROJECT: "",
+      BRANCH: process.env.NETLIFY_BRANCH ?? "next",
+      CLOUD_API_URL: process.env.CLOUD_API_URL ?? "",
     },
   },
 
@@ -49,6 +96,7 @@ export default defineNuxtConfig({
     "vuetify-nuxt-module",
     ["@pinia/nuxt", { autoImports: ["defineStore", "storeToRefs"] }],
     "@vueuse/nuxt",
+    setAppPackageConfig,
   ],
   imports: {
     scan: false,

package/opengeodeweb_front_schemas.json

@@ -210,21 +210,6 @@
           "additionalProperties": false
         }
       }
-    },
-    "serverless": {
-      "run_cloud": {
-        "$id": "api/serverless/run_cloud",
-        "route": "/run_cloud",
-        "methods": ["POST"],
-        "type": "object",
-        "properties": {
-          "email": {
-            "type": "string"
-          }
-        },
-        "required": ["email"],
-        "additionalProperties": false
-      }
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geode/opengeodeweb-front",
-  "version": "10.34.0",
+  "version": "10.35.0-rc.2",
   "description": "OpenSource Vue/Nuxt/Pinia/Vuetify framework for web applications",
   "homepage": "https://github.com/Geode-solutions/OpenGeodeWeb-Front",
   "bugs": {
@@ -62,9 +62,8 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@geode/opengeodeweb-back": "latest",
-    "@geode/opengeodeweb-viewer": "latest",
-    "@google-cloud/run": "4.1.0",
+    "@geode/opengeodeweb-back": "next",
+    "@geode/opengeodeweb-viewer": "next",
     "@kitware/vtk.js": "33.3.0",
     "@mdi/font": "7.4.47",
     "@pinia/nuxt": "1.0.1",
@@ -80,8 +79,6 @@
     "conf": "15.1.0",
     "dexie": "4.2.1",
     "get-port-please": "3.2.0",
-    "google-auth-library": "11.0.2",
-    "googleapis": "181.0.0",
     "js-file-download": "0.4.12",
     "jszip": "3.10.1",
     "lodash": "4.18.1",

package/server/utils/cloud.ts

@@ -4,111 +4,11 @@ import fs from "node:fs";
 import path from "node:path";
 
 // Third party imports
-import type { AuthClient, OAuth2Client } from "google-auth-library";
-import { google } from "googleapis";
-import type { protos } from "@google-cloud/run";
 
 // Local imports
 
-// oxlint-disable-next-line eslint/id-length
-type CreateServiceRequest = protos.google.cloud.run.v2.ICreateServiceRequest;
-
 const LOCATIONS_DIR = "/etc/nginx/locations";
 
-async function artifactImage(parent: string, authClient: AuthClient): Promise<string> {
-  const projectName = process.env.PROJECT;
-  const registry = google.artifactregistry({
-    version: "v1",
-    // oxlint-disable-next-line typescript/no-unsafe-type-assertion
-    auth: authClient as OAuth2Client,
-  });
-  const branch = process.env.NETLIFY_BRANCH;
-  const [, projectId] = parent.split("/");
-  const repository = `${parent}/repositories/github/packages/`;
-  const name = `${repository}${projectName}/tags/${branch}`;
-  console.log({ name });
-  const response = await registry.projects.locations.repositories.packages.tags.get({
-    name,
-  });
-  console.log({ response });
-  const version = response.data.version ?? "";
-  const digest = version.split("/").pop();
-  const artifactRegistry = `europe-west9-docker.pkg.dev/${projectId}/github`;
-  const image = `${artifactRegistry}/${projectName}@${digest}`;
-  console.log("Found image for", projectName, image);
-  return image;
-}
-
-function sanitizeLabelValue(label: string): string {
-  console.log("label", label);
-  const maxLabelLength = 63;
-  return label
-    .toLowerCase()
-    .replaceAll(/[^a-z0-9_-]/gu, "_")
-    .slice(0, maxLabelLength);
-}
-
-function requestConfig(
-  parent: string,
-  image: string,
-  email: string,
-  projectName: string,
-): CreateServiceRequest {
-  const resources = {
-    limits: {
-      cpu: "2000m",
-      memory: "3Gi",
-    },
-    cpuIdle: false,
-    startupCpuBoost: true,
-  };
-  const labels = {
-    user: sanitizeLabelValue(email),
-    project: sanitizeLabelValue(projectName),
-  };
-  return {
-    parent,
-    service: {
-      ingress: "INGRESS_TRAFFIC_ALL",
-      invokerIamDisabled: true,
-      labels,
-      scaling: {
-        scalingMode: "MANUAL",
-        manualInstanceCount: 1,
-      },
-      template: {
-        labels,
-        timeout: { seconds: 3600 },
-        containers: [
-          {
-            image,
-            ports: [
-              {
-                containerPort: 80,
-              },
-            ],
-            resources,
-            env: [
-              {
-                name: "PARENT",
-                value: parent,
-              },
-            ],
-            startupProbe: {
-              httpGet: {
-                port: 80,
-                path: "/viewer/healthcheck",
-              },
-              periodSeconds: 1,
-              failureThreshold: 30,
-            },
-          },
-        ],
-      },
-    },
-  };
-}
-
 function addSupervisorProgram(
   name: string,
   command: string,
@@ -211,10 +111,4 @@ function removeNginxLocation(name: string): boolean {
   return true;
 }
 
-export {
-  addNginxLocation,
-  addSupervisorProgram,
-  artifactImage,
-  removeNginxLocation,
-  requestConfig,
-};
+export { addNginxLocation, addSupervisorProgram, removeNginxLocation };

package/server/api/serverless/run_cloud.post.ts

@@ -1,92 +0,0 @@
-// Node imports
-
-// Third party imports
-import { GoogleAuth, type JWTInput } from "google-auth-library";
-import { type H3Event, createError, defineEventHandler, readBody } from "h3";
-import { ServicesClient } from "@google-cloud/run";
-
-// Local imports
-import { artifactImage, requestConfig } from "@geode/opengeodeweb-front/server/utils/cloud.ts";
-
-interface RunCloudBody {
-  email: string;
-}
-
-function isServiceAccountCredentials(value: unknown): value is JWTInput {
-  return (
-    typeof value === "object" && value !== null && "client_email" in value && "private_key" in value
-  );
-}
-
-export default defineEventHandler(async (event: H3Event) => {
-  try {
-    const { email } = await readBody<RunCloudBody>(event);
-    console.log("[RUN CLOUD] Received request to create backend for email:", email);
-
-    const { GOOGLE_CLOUD_KEY, GOOGLE_CLOUD_PROJECT, PROJECT } = process.env;
-
-    if (
-      GOOGLE_CLOUD_KEY === undefined ||
-      GOOGLE_CLOUD_KEY === "" ||
-      GOOGLE_CLOUD_PROJECT === undefined ||
-      GOOGLE_CLOUD_PROJECT === "" ||
-      PROJECT === undefined ||
-      PROJECT === ""
-    ) {
-      throw createError({
-        statusCode: 500,
-        statusMessage:
-          "Missing required environment variables: GOOGLE_CLOUD_KEY, GOOGLE_CLOUD_PROJECT, or PROJECT",
-      });
-    }
-
-    const projectId: string = GOOGLE_CLOUD_PROJECT;
-    const projectName: string = PROJECT;
-
-    const parsedKey: unknown = JSON.parse(GOOGLE_CLOUD_KEY);
-    if (!isServiceAccountCredentials(parsedKey)) {
-      throw createError({
-        statusCode: 500,
-        statusMessage: "GOOGLE_CLOUD_KEY is not a valid service account credentials JSON",
-      });
-    }
-    const credentials: JWTInput = parsedKey;
-
-    const location = "europe-west9";
-    const parent = `projects/${projectId}/locations/${location}`;
-    console.log({ parent });
-
-    const auth = new GoogleAuth({
-      // oxlint-disable-next-line typescript/no-deprecated
-      credentials,
-      scopes: ["https://www.googleapis.com/auth/cloud-platform"],
-    });
-    const authClient = await auth.getClient();
-    const image = await artifactImage(parent, authClient);
-    const request = requestConfig(parent, image, email, projectName);
-    console.log({ request });
-
-    const runClient = new ServicesClient({ authClient });
-    const [operation] = await runClient.createService(request);
-    const [response] = await operation.promise();
-
-    if (response.uri === null || response.uri === undefined || response.uri === "") {
-      throw createError({
-        statusCode: 500,
-        statusMessage: "Cloud Run service created but no URI was returned",
-      });
-    }
-
-    console.log("Service URL created:", response.uri);
-    return {
-      statusCode: 200,
-      url: response.uri.replace(/^https?:\/\//iu, ""),
-    };
-  } catch (error) {
-    console.log(error);
-    throw createError({
-      statusCode: 500,
-      statusMessage: error instanceof Error ? error.message : String(error),
-    });
-  }
-});

package/server/api/serverless/schemas/run_cloud.json

@@ -1,10 +0,0 @@
-{
-  "route": "/run_cloud",
-  "methods": ["POST"],
-  "type": "object",
-  "properties": {
-    "email": { "type": "string" }
-  },
-  "required": ["email"],
-  "additionalProperties": false
-}