akanjs 0.0.1 → 2.0.0-beta.0

package/cli/templates/workspaceRoot/infra/app/templates/frontend.yaml.template

@@ -0,0 +1,182 @@
+{{- $namespaceParts := split "-" .Release.Namespace }}
+{{- $branch := index $namespaceParts "_1" }}
+{{- $config := index .Values $branch }}
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: frontend-deployment
+  namespace: {{ .Values.appName }}-{{ $branch }}
+  labels:
+    app: frontend
+spec:
+  replicas: {{ $config.frontend.replicas }}
+  selector:
+    matchLabels:
+      app: frontend
+  template:
+    metadata:
+      labels:
+        app: frontend
+    spec:
+      containers:
+        - name: frontend
+          image: registry.akamir.com/{{ .Values.repoName }}/{{ .Values.appName }}/frontend:{{ $branch }}-live
+          imagePullPolicy: Always
+          ports:
+            - containerPort: 4200
+          resources:
+            requests:
+              memory: {{ $config.frontend.resources.requests.memory }}
+              cpu: {{ $config.frontend.resources.requests.cpu }}
+            limits:
+              memory: {{ $config.frontend.resources.limits.memory }}
+              cpu: {{ $config.frontend.resources.limits.cpu }}
+      imagePullSecrets:
+        - name: regcred
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: frontend-svc
+  namespace: {{ .Values.appName }}-{{ $branch }}
+spec:
+  selector:
+    app: frontend
+  ports:
+    - protocol: TCP
+      port: 4200
+      targetPort: 4200
+---
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: app-ingress
+  namespace: {{ .Values.appName }}-{{ $branch }}
+  annotations:
+    ingress.kubernetes.io/ssl-redirect: "true"
+    kubernetes.io/tls-acme: "true"
+    cert-manager.io/cluster-issuer: letsencrypt-prod
+    nginx.ingress.kubernetes.io/enable-cors: "true"
+    nginx.ingress.kubernetes.io/proxy-body-size: "0"
+    nginx.ingress.kubernetes.io/affinity: "cookie"
+    nginx.ingress.kubernetes.io/session-cookie-name: "route"
+    nginx.ingress.kubernetes.io/session-cookie-expires: "172800"
+    nginx.ingress.kubernetes.io/session-cookie-max-age: "172800"
+    nginx.ingress.kubernetes.io/cors-allow-headers: "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization,apollo-require-preflight"
+    nginx.ingress.kubernetes.io/use-regex: "true"
+    nginx.ingress.kubernetes.io/allow-snippet-annotations: "true"
+    nginx.ingress.kubernetes.io/rewrite-target: /$2$3
+    nginx.ingress.kubernetes.io/proxy-buffer-size: "16k"
+    nginx.ingress.kubernetes.io/proxy-buffers-number: "4"
+    nginx.ingress.kubernetes.io/proxy-busy-buffers-size: "24k"
+spec:
+  ingressClassName: nginx
+  tls:
+    - hosts:
+        - {{ .Values.appName }}-{{ $branch }}.akamir.com
+{{- range $i, $subRoute := .Values.subRoutes }}
+        - {{ $subRoute }}-{{ $branch }}.akamir.com
+{{ end}}
+{{- range $i, $domain := $config.domains }}
+        - {{ $domain }}
+{{ end}}
+      secretName: cert-{{ .Values.appName }}-{{ $branch }}
+  rules:
+    - host: {{ .Values.appName }}-{{ $branch }}.akamir.com
+      http:
+        paths:
+          - path: /(search)(.*)
+            pathType: ImplementationSpecific
+            backend:
+              service:
+                name: meili-svc
+                port:
+                  number: 7700
+          - path: /()(backend)(.*)
+            pathType: ImplementationSpecific
+            backend:
+              service:
+                name: backend-svc
+                port:
+                  number: 8080
+          - path: /()(socket.io)(.*)
+            pathType: ImplementationSpecific
+            backend:
+              service:
+                name: backend-svc
+                port:
+                  number: 8080
+          - path: /()(.*)
+            pathType: ImplementationSpecific
+            backend:
+              service:
+                name: frontend-svc
+                port:
+                  number: 4200
+{{- range $i, $subRoute := .Values.subRoutes }}
+    - host: {{ $subRoute }}-{{ $branch }}.akamir.com
+      http:
+        paths:
+          - path: /(search)(.*)
+            pathType: ImplementationSpecific
+            backend:
+              service:
+                name: meili-svc
+                port:
+                  number: 7700
+          - path: /()(backend)(.*)
+            pathType: ImplementationSpecific
+            backend:
+              service:
+                name: backend-svc
+                port:
+                  number: 8080
+          - path: /()(socket.io)(.*)
+            pathType: ImplementationSpecific
+            backend:
+              service:
+                name: backend-svc
+                port:
+                  number: 8080
+          - path: /()(.*)
+            pathType: ImplementationSpecific
+            backend:
+              service:
+                name: frontend-svc
+                port:
+                  number: 4200
+{{ end }}
+{{- range $i, $domain := $config.domains }}
+    - host: {{ $domain }}
+      http:
+        paths:
+          - path: /(search)(.*)
+            pathType: ImplementationSpecific
+            backend:
+              service:
+                name: meili-svc
+                port:
+                  number: 7700
+          - path: /()(backend)(.*)
+            pathType: ImplementationSpecific
+            backend:
+              service:
+                name: backend-svc
+                port:
+                  number: 8080
+          - path: /()(socket.io)(.*)
+            pathType: ImplementationSpecific
+            backend:
+              service:
+                name: backend-svc
+                port:
+                  number: 8080
+          - path: /()(.*)
+            pathType: ImplementationSpecific
+            backend:
+              service:
+                name: frontend-svc
+                port:
+                  number: 4200
+{{ end }}

package/cli/templates/workspaceRoot/infra/app/values/_common-values.yaml.template

@@ -0,0 +1,183 @@
+repoName: undefined
+appName: undefined
+subRoutes: []
+debug:
+  domains: []
+  backend:
+    federation:
+      replicas: 1
+      resources:
+        requests:
+          memory: 250M
+          cpu: "0.05"
+        limits:
+          memory: 1G
+          cpu: "0.5"
+    batch:
+      resources:
+        requests:
+          memory: 250M
+          cpu: "0.05"
+        limits:
+          memory: 1G
+          cpu: "0.5"
+  frontend:
+    replicas: 1
+    resources:
+      requests:
+        memory: 250M
+        cpu: "0.1"
+      limits:
+        memory: 1G
+        cpu: "0.5"
+  redis:
+    replicas: 1
+    resources:
+      requests:
+        cpu: "0.05"
+        memory: 200M
+      limits:
+        cpu: "1"
+        memory: 2G
+  mongo:
+    replicas: 1
+    storage:
+      data: 2G
+      logs: 0.5G
+    resources:
+      requests:
+        cpu: "0.15"
+        memory: 200M
+      limits:
+        cpu: "4"
+        memory: 4G
+  meili:
+    storage:
+      data: 2G
+    resources:
+      requests:
+        cpu: "0.15"
+        memory: 200M
+      limits:
+        cpu: "4"
+        memory: 4G
+develop:
+  domains: []
+  backend:
+    federation:
+      replicas: 1
+      resources:
+        requests:
+          memory: 250M
+          cpu: "0.05"
+        limits:
+          memory: 1G
+          cpu: "0.5"
+    batch:
+      resources:
+        requests:
+          memory: 250M
+          cpu: "0.05"
+        limits:
+          memory: 1G
+          cpu: "0.5"
+  frontend:
+    replicas: 1
+    resources:
+      requests:
+        memory: 250M
+        cpu: "0.1"
+      limits:
+        memory: 1G
+        cpu: "0.5"
+  redis:
+    replicas: 1
+    resources:
+      requests:
+        cpu: "0.05"
+        memory: 200M
+      limits:
+        cpu: "1"
+        memory: 2G
+  mongo:
+    replicas: 1
+    storage:
+      data: 2G
+      logs: 0.5G
+    resources:
+      requests:
+        cpu: "0.15"
+        memory: 200M
+      limits:
+        cpu: "4"
+        memory: 4G
+  meili:
+    storage:
+      data: 2G
+    resources:
+      requests:
+        cpu: "0.15"
+        memory: 200M
+      limits:
+        cpu: "4"
+        memory: 4G
+main:
+  domains: []
+  backend:
+    federation:
+      replicas: 1
+      resources:
+        requests:
+          memory: 250M
+          cpu: "0.05"
+        limits:
+          memory: 1G
+          cpu: "0.5"
+    batch:
+      resources:
+        requests:
+          memory: 250M
+          cpu: "0.05"
+        limits:
+          memory: 1G
+          cpu: "0.5"
+  frontend:
+    replicas: 1
+    resources:
+      requests:
+        memory: 1G
+        cpu: "1"
+      limits:
+        memory: 4G
+        cpu: "4"
+  redis:
+    replicas: 1
+    resources:
+      requests:
+        cpu: "0.05"
+        memory: 200M
+      limits:
+        cpu: "1"
+        memory: 2G
+  mongo:
+    replicas: 1
+    storage:
+      data: 2G
+      logs: 0.5G
+    resources:
+      requests:
+        cpu: "0.15"
+        memory: 200M
+      limits:
+        cpu: "4"
+        memory: 4G
+  meili:
+    storage:
+      data: 2G
+    resources:
+      requests:
+        cpu: "0.15"
+        memory: 200M
+      limits:
+        cpu: "4"
+        memory: 4G

package/cli/templates/workspaceRoot/package.json.template

@@ -0,0 +1,7 @@
+{
+  "name": "<%= repoName %>",
+  "description": "<%= repoName %> workspace",
+  "version": "0.0.1",
+  "dependencies": {},
+  "devDependencies": {}
+}

package/cli/templates/workspaceRoot/tsconfig.json.template

@@ -0,0 +1,26 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "rootDir": ".",
+    "sourceMap": true,
+    "declaration": false,
+    "moduleResolution": "node",
+    "emitDecoratorMetadata": true,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "experimentalDecorators": true,
+    "noPropertyAccessFromIndexSignature": false,
+    "importHelpers": false,
+    "target": "es2022",
+    "module": "esnext",
+    "types": ["node", "vite/client", "jest"],
+    "lib": ["es2022", "dom", "webworker"],
+    "skipLibCheck": true,
+    "skipDefaultLibCheck": true,
+    "strictNullChecks": true,
+    "baseUrl": ".",
+    "jsx": "preserve",
+    "resolveJsonModule": true
+  },
+  "exclude": ["**/node_modules", "tmp", "**/ios", "**/android"]
+}

package/cli/testHelpers.ts

@@ -0,0 +1,171 @@
+import { mkdir, mkdtemp, rm, writeFile } from "node:fs/promises";
+import os from "node:os";
+import path from "node:path";
+import { AppExecutor, LibExecutor, ModuleExecutor, PkgExecutor, WorkspaceExecutor } from "akanjs/devkit";
+
+export interface CallRecord {
+  name: string;
+  args: unknown[];
+}
+
+export const createCallRecorder = () => {
+  const calls: CallRecord[] = [];
+  return {
+    calls,
+    record(name: string, ...args: unknown[]) {
+      calls.push({ name, args });
+    },
+    names() {
+      return calls.map((call) => call.name);
+    },
+  };
+};
+
+export const createFakeSpinner = (recorder = createCallRecorder()) => ({
+  succeed: (message?: string) => recorder.record("spinner.succeed", message),
+  fail: (message?: string) => recorder.record("spinner.fail", message),
+});
+
+export const createFakeExecutor = <Extra extends object = object>(
+  name: string,
+  extra: Extra = {} as Extra,
+  recorder = createCallRecorder(),
+) =>
+  ({
+    name,
+    cwdPath: `/workspace/${name}`,
+    workspaceRoot: "/workspace",
+    spinning: (message: string) => {
+      recorder.record(`${name}.spinning`, message);
+      return createFakeSpinner(recorder);
+    },
+    spawn: async (...args: unknown[]) => {
+      recorder.record(`${name}.spawn`, ...args);
+      return "";
+    },
+    exec: async (...args: unknown[]) => {
+      recorder.record(`${name}.exec`, ...args);
+      return "";
+    },
+    scan: async (...args: unknown[]) => {
+      recorder.record(`${name}.scan`, ...args);
+      return { name };
+    },
+    scanSync: async (...args: unknown[]) => {
+      recorder.record(`${name}.scanSync`, ...args);
+      return { name };
+    },
+    ...extra,
+  }) as Extra & {
+    name: string;
+    cwdPath: string;
+    workspaceRoot: string;
+    spinning: (message: string) => ReturnType<typeof createFakeSpinner>;
+    spawn: (...args: unknown[]) => Promise<string>;
+    exec: (...args: unknown[]) => Promise<string>;
+    scan: (...args: unknown[]) => Promise<{ name: string }>;
+    scanSync: (...args: unknown[]) => Promise<{ name: string }>;
+  };
+
+export const makeCliTempWorkspace = async () => {
+  const root = await mkdtemp(path.join(os.tmpdir(), "akan-cli-"));
+  await mkdir(root, { recursive: true });
+  await writeText(path.join(root, ".gitignore"), "");
+  const workspace = new WorkspaceExecutor({ workspaceRoot: root, repoName: "repo" });
+  return { root, workspace };
+};
+
+export const cleanupCliTempWorkspace = async (root: string) => {
+  await rm(root, { recursive: true, force: true });
+};
+
+export const writeText = async (filePath: string, content: string) => {
+  await mkdir(path.dirname(filePath), { recursive: true });
+  await writeFile(filePath, content);
+};
+
+export const writeJson = async (filePath: string, value: object) => {
+  await writeText(filePath, `${JSON.stringify(value, null, 2)}\n`);
+};
+
+export const createTempApp = async (appName = "demo") => {
+  const { root, workspace } = await makeCliTempWorkspace();
+  await writeJson(path.join(root, "package.json"), {
+    name: "repo",
+    version: "1.0.0",
+    description: "repo",
+    dependencies: {
+      react: "19.0.0",
+      "react-dom": "19.0.0",
+      "react-server-dom-webpack": "19.0.0",
+      sharp: "1.0.0",
+    },
+  });
+  await writeJson(path.join(root, "tsconfig.json"), {
+    compilerOptions: { target: "ESNext", paths: {} },
+    references: [],
+  });
+  await writeJson(path.join(root, "apps", appName, "tsconfig.json"), {
+    compilerOptions: { target: "ESNext", paths: {} },
+  });
+  await writeJson(path.join(root, "apps", appName, "package.json"), {
+    name: appName,
+    version: "1.0.0",
+    description: appName,
+    dependencies: {},
+    devDependencies: {},
+  });
+  await writeText(path.join(root, "apps", appName, "akan.config.ts"), "export default {};\n");
+  await mkdir(path.join(root, "apps", appName, "lib", "__scalar"), { recursive: true });
+  const app = AppExecutor.from(workspace, appName);
+  return { root, workspace, app };
+};
+
+export const createTempLib = async (libName = "shared") => {
+  const { root, workspace } = await makeCliTempWorkspace();
+  await writeJson(path.join(root, "package.json"), {
+    name: "repo",
+    version: "1.0.0",
+    description: "repo",
+    dependencies: {},
+    devDependencies: {},
+  });
+  await writeJson(path.join(root, "tsconfig.json"), {
+    compilerOptions: { target: "ESNext", paths: {} },
+    references: [],
+  });
+  const lib = LibExecutor.from(workspace, libName);
+  return { root, workspace, lib };
+};
+
+export const createTempPackage = async (pkgName = "@sample/tool") => {
+  const { root, workspace } = await makeCliTempWorkspace();
+  await writeJson(path.join(root, "package.json"), {
+    name: "repo",
+    version: "1.0.0",
+    description: "repo",
+    dependencies: { lodash: "4.0.0" },
+    devDependencies: { typescript: "6.0.0" },
+  });
+  await writeJson(path.join(root, "tsconfig.json"), {
+    compilerOptions: { target: "ESNext", paths: {} },
+  });
+  await writeJson(path.join(root, "pkgs", pkgName, "package.json"), {
+    name: pkgName,
+    version: "0.1.0",
+    description: "tool",
+    exports: {},
+  });
+  await writeJson(path.join(root, "pkgs", pkgName, "tsconfig.json"), {
+    compilerOptions: { target: "ESNext", paths: {} },
+  });
+  await writeText(path.join(root, "pkgs", pkgName, "index.ts"), 'import "lodash";\nexport const value = 1;\n');
+  const pkg = PkgExecutor.from(workspace, pkgName);
+  return { root, workspace, pkg };
+};
+
+export const createTempModule = async (moduleName = "post") => {
+  const { root, workspace, app } = await createTempApp("demo");
+  const module = ModuleExecutor.from(app, moduleName);
+  return { root, workspace, app, module };
+};

package/cli/workspace/workspace.command.ts

@@ -0,0 +1,60 @@
+import { command, Exec, Workspace } from "akanjs/devkit";
+
+import { WorkspaceScript } from "./workspace.script";
+
+export class WorkspaceCommand extends command("workspace", [WorkspaceScript], ({ public: target }) => ({
+  createWorkspace: target({ desc: "Create a new Akan.js workspace", runsOnWorkspaceRoot: false })
+    .arg("workspaceName", String, { desc: "what is the name of your organization?" })
+    .option("app", String, {
+      desc: "what is the codename of your first application? (e.g. myapp)",
+      default: "app",
+    })
+    .option("dir", String, {
+      desc: "directory of workspace",
+      default: process.env.USE_AKANJS_PKGS === "true" ? "local" : ".",
+    })
+    .option("libs", Boolean, {
+      desc: "Do you want to install shared and util libraries? (admin, user file, etc.)",
+      enum: [
+        { label: "No, I want to start with empty workspace (Recommended)", value: false },
+        {
+          label: "Yes, I want to accelerate development by installing shared and util libraries (for akanjs experts)",
+          value: true,
+        },
+      ],
+    })
+    .option("tag", String, {
+      desc: "tag of the update",
+      default: "latest",
+    })
+    .option("init", Boolean, {
+      desc: "Do you want to initialize the workspace? (Recommended)",
+      default: true,
+    })
+    .exec(async function (workspaceName, app, dir, libs, tag, init) {
+      const appName = app || "app";
+      await this.workspaceScript.createWorkspace(
+        workspaceName.toLowerCase().replace(/ /g, "-"),
+        appName.toLowerCase().replace(/ /g, "-"),
+        { dirname: dir, installLibs: libs, tag, init },
+      );
+    }),
+  lint: target({ desc: "Lint and fix code in a specific app/lib/pkg" })
+    .with(Exec)
+    .option("fix", Boolean, { default: true })
+    .with(Workspace)
+    .exec(async function (exec, fix, workspace) {
+      await this.workspaceScript.lint(exec, workspace, { fix });
+    }),
+  lintAll: target({ desc: "Lint and fix code in all apps and libraries" })
+    .option("fix", Boolean, { default: true })
+    .with(Workspace)
+    .exec(async function (fix, workspace) {
+      await this.workspaceScript.lintAll(workspace, { fix });
+    }),
+  syncAll: target({ desc: "Sync dependencies and configuration for all apps and libraries" })
+    .with(Workspace)
+    .exec(async function (workspace) {
+      await this.workspaceScript.syncAll(workspace);
+    }),
+})) {}

package/cli/workspace/workspace.runner.ts

@@ -0,0 +1,57 @@
+import path from "node:path";
+import { type Exec, type PackageJson, runner, type Workspace, WorkspaceExecutor } from "akanjs/devkit";
+import latestVersion from "latest-version";
+
+export class WorkspaceRunner extends runner("workspace") {
+  async #resolveAkanVersion(tag: string) {
+    return /^\d+\.\d+\.\d+(?:[-+][0-9A-Za-z.-]+)?$/.test(tag) ? tag : await latestVersion("akanjs", { version: tag });
+  }
+
+  async createWorkspace(
+    repoName: string,
+    appName: string,
+    { dirname = ".", tag = "latest", init = true }: { dirname?: string; tag?: string; init?: boolean },
+  ) {
+    const cwdPath = process.cwd();
+    const workspaceRoot = path.join(cwdPath, dirname, repoName);
+
+    const workspace = WorkspaceExecutor.fromRoot({ workspaceRoot, repoName });
+    const templateSpinner = workspace.spinning(`Creating workspace template files in ${dirname}/${repoName}...`);
+    await workspace.applyTemplate({
+      basePath: ".",
+      template: "workspaceRoot",
+      dict: { repoName, appName, serveDomain: "localhost" },
+    });
+    templateSpinner.succeed(`Workspace files created in ${dirname}/${repoName}`);
+    
+    const rootPackageJson = await workspace.getPackageJson();
+    const akanVersion = await this.#resolveAkanVersion(tag);
+    const packageJson: PackageJson = {
+      ...rootPackageJson,
+      dependencies: {
+        ...rootPackageJson.dependencies,
+        akanjs: akanVersion,
+      },
+      devDependencies: {
+        ...rootPackageJson.devDependencies,
+      },
+    };
+    await workspace.setPackageJson(packageJson);
+
+    if (init) {
+      const installSpinner = workspace.spinning("Installing dependencies with bun...");
+      await workspace.spawn("bun", ["install"]);
+      installSpinner.succeed("Dependencies installed with bun");
+    }
+
+    return workspace;
+  }
+  async lint(exec: Exec, workspace: Workspace, { fix = true }: { fix?: boolean } = {}) {
+    await workspace.spawn("./node_modules/.bin/biome", [
+      "check",
+      ...(fix ? ["--write"] : []),
+      "--no-errors-on-unmatched",
+      exec.cwdPath,
+    ]);
+  }
+}