@lensjs/adonis 1.0.1

package/LICENSE.md

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright (c) 2023
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+- first user should add the running console in bin/console file

package/build/configure.d.ts

@@ -0,0 +1,2 @@
+import ConfigureCommand from '@adonisjs/core/commands/configure';
+export declare function configure(command: ConfigureCommand): Promise<void>;

package/build/configure.js

@@ -0,0 +1,38 @@
+/*
+|--------------------------------------------------------------------------
+| Configure hook
+|--------------------------------------------------------------------------
+|
+| The configure hook is called when someone runs "node ace configure <package>"
+| command. You are free to perform any operations inside this function to
+| configure the package.
+|
+| To make things easier, you have access to the underlying "ConfigureCommand"
+| instance and you can use codemods to modify the source files.
+|
+*/
+import { stubsRoot } from './stubs/main.js';
+const registerEnvValidation = async (codemods) => {
+    try {
+        await codemods.defineEnvValidations({
+            leadingComment: 'Node lens variables',
+            variables: {
+                LENS_BASE_PATH: 'Env.schema.string.optional()',
+                LENS_ENABLED: 'Env.schema.boolean.optional()',
+                LENS_ENABLE_QUERY_WATCHER: 'Env.schema.boolean.optional()',
+                LENS_ENABLE_REQUEST_WATCHER: 'Env.schema.boolean.optional()',
+            },
+        });
+    }
+    catch (error) {
+        console.error(error);
+    }
+};
+export async function configure(command) {
+    const codemods = await command.createCodemods();
+    await registerEnvValidation(codemods);
+    await codemods.makeUsingStub(stubsRoot, 'config/lens.stub', {});
+    await codemods.updateRcFile((rcFile) => {
+        rcFile.addProvider('@lensjs/adonis/lens_provider');
+    });
+}

package/build/index.d.ts

@@ -0,0 +1,4 @@
+export { configure } from './configure.js';
+export { defineConfig } from './src/define_config.js';
+export { stubsRoot } from './stubs/main.js';
+export { default as LensAdapter } from './src/adapter.js';

package/build/index.js

@@ -0,0 +1,12 @@
+/*
+|--------------------------------------------------------------------------
+| Package entrypoint
+|--------------------------------------------------------------------------
+|
+| Export values from the package entrypoint as you see fit.
+|
+*/
+export { configure } from './configure.js';
+export { defineConfig } from './src/define_config.js';
+export { stubsRoot } from './stubs/main.js';
+export { default as LensAdapter } from './src/adapter.js';

package/build/providers/lens_service_provider.d.ts

@@ -0,0 +1,14 @@
+import type { ApplicationService } from '@adonisjs/core/types';
+import { LensConfig } from '../src/define_config.js';
+import { QueryEntry } from '@lensjs/core';
+declare module '@adonisjs/core/types' {
+    interface ContainerBindings {
+        lensConfig: LensConfig;
+        queries?: QueryEntry['data'][];
+    }
+}
+export default class LensServiceProvider {
+    protected app: ApplicationService;
+    constructor(app: ApplicationService);
+    boot(): Promise<void>;
+}

package/build/providers/lens_service_provider.js

@@ -0,0 +1,39 @@
+import { configProvider } from '@adonisjs/core';
+import { RuntimeException } from '@poppinss/utils';
+import { Lens, lensUtils, RequestWatcher, QueryWatcher } from '@lensjs/core';
+import AdonisAdapter from '../src/adapter.js';
+export default class LensServiceProvider {
+    app;
+    constructor(app) {
+        this.app = app;
+    }
+    async boot() {
+        const lensConfigProvider = this.app.config.get('lens');
+        const config = await configProvider.resolve(this.app, lensConfigProvider);
+        if (!config) {
+            throw new RuntimeException('Invalid "config/lens.ts" file. Make sure you are using the "defineConfig" method');
+        }
+        const { normalizedPath, ignoredPaths } = lensUtils.prepareIgnoredPaths(config.path, config.ignoredPaths);
+        config.ignoredPaths = ignoredPaths;
+        this.app.container.bindValue('lensConfig', config);
+        this.app.booted(async () => {
+            const watchersMap = {
+                requests: new RequestWatcher(),
+                queries: new QueryWatcher(),
+            };
+            const allowedWatchers = Object.keys(config.watchers)
+                .filter((watcher) => config.watchers[watcher])
+                .map((watcher) => watchersMap[watcher])
+                .filter((watcher) => !!watcher);
+            const adapter = new AdonisAdapter({ app: this.app })
+                .setConfig(config)
+                .setIgnoredPaths(ignoredPaths)
+                .setOnlyPaths(config.onlyPaths);
+            await Lens.setWatchers(allowedWatchers).setAdapter(adapter).start({
+                basePath: normalizedPath,
+                enabled: config.enabled,
+                appName: config.appName,
+            });
+        });
+    }
+}

package/build/src/adapter.d.ts

@@ -0,0 +1,22 @@
+import { RouteDefinition, LensAdapter, RequestWatcher, QueryWatcher } from '@lensjs/core';
+import type { ApplicationService, EmitterService, HttpRouterService } from '@adonisjs/core/types';
+import { LensConfig } from './define_config.js';
+export default class AdonisAdapter extends LensAdapter {
+    protected app: ApplicationService;
+    protected router: HttpRouterService;
+    protected emitter: EmitterService;
+    protected isRequestWatcherEnabled: boolean;
+    protected queryWatcher?: QueryWatcher;
+    protected config: LensConfig;
+    constructor({ app }: {
+        app: ApplicationService;
+    });
+    setup(): void;
+    setConfig(config: LensConfig): this;
+    registerRoutes(routes: RouteDefinition[]): void;
+    protected watchRequests(requestWatcher: RequestWatcher): void;
+    protected watchQueries(queryWatcher: QueryWatcher): Promise<void>;
+    serveUI(uiPath: string, spaRoute: string, _dataToInject: Record<string, any>): void;
+    private matchStaticFiles;
+    private getUserFromContext;
+}

package/build/src/adapter.js

@@ -0,0 +1,124 @@
+import { LensAdapter, WatcherTypeEnum, lensUtils, } from '@lensjs/core';
+import * as path from 'path';
+import { shouldIgnoreLogging } from './utils/index.js';
+import string from '@adonisjs/core/helpers/string';
+export default class AdonisAdapter extends LensAdapter {
+    app;
+    router;
+    emitter;
+    isRequestWatcherEnabled = false;
+    queryWatcher;
+    config;
+    constructor({ app }) {
+        super();
+        this.app = app;
+    }
+    setup() {
+        this.app.booted(async () => {
+            this.router = await this.app.container.make('router');
+            this.emitter = await this.app.container.make('emitter');
+            for (const watcher of this.getWatchers()) {
+                switch (watcher.name) {
+                    case WatcherTypeEnum.REQUEST:
+                        this.isRequestWatcherEnabled = true;
+                        this.watchRequests(watcher);
+                        break;
+                    case WatcherTypeEnum.QUERY:
+                        this.queryWatcher = watcher;
+                        await this.watchQueries(watcher);
+                        break;
+                }
+            }
+        });
+    }
+    setConfig(config) {
+        this.config = config;
+        return this;
+    }
+    registerRoutes(routes) {
+        this.app.booted(async () => {
+            routes.forEach((route) => {
+                this.router[route.method.toLowerCase()](route.path, async (ctx) => {
+                    const data = await route.handler({ params: ctx.params, qs: ctx.request.qs() });
+                    return ctx.response.json(data);
+                });
+            });
+        });
+    }
+    watchRequests(requestWatcher) {
+        const self = this;
+        if (shouldIgnoreLogging(this.app) || !self.isRequestWatcherEnabled)
+            return;
+        this.emitter.on('http:request_completed', async function (event) {
+            if (self.shouldIgnorePath(event.ctx.request.url(false)))
+                return;
+            const request = event.ctx.request;
+            const requestId = lensUtils.generateRandomUuid();
+            const logPayload = {
+                request: {
+                    id: requestId,
+                    method: request.method(),
+                    duration: string.prettyHrTime(event.duration),
+                    path: request.url(true),
+                    headers: request.headers(),
+                    body: request.hasBody() ? request.body() : {},
+                    status: event.ctx.response.response.statusCode,
+                    ip: request.ip(),
+                    createdAt: lensUtils.nowISO(),
+                },
+                response: {
+                    json: event.ctx.response.getBody(),
+                    headers: event.ctx.response.getHeaders(),
+                },
+                user: await self.getUserFromContext(event.ctx),
+            };
+            await requestWatcher.log(logPayload);
+        });
+    }
+    async watchQueries(queryWatcher) {
+        const self = this;
+        this.app.booted(async () => {
+            if (shouldIgnoreLogging(self.app))
+                return;
+            // @ts-ignore
+            this.emitter.on('db:query', async function (query) {
+                const duration = query.duration ? string.prettyHrTime(query.duration) : '0 ms';
+                const payload = {
+                    query: lensUtils.formatSqlQuery(lensUtils.interpolateQuery(query.sql, query.bindings), self.config.watchers.queries.provider),
+                    duration,
+                    createdAt: lensUtils.sqlDateTime(),
+                    type: self.config.watchers.queries.provider,
+                };
+                await queryWatcher.log({
+                    data: payload,
+                });
+            });
+        });
+    }
+    serveUI(uiPath, spaRoute, _dataToInject) {
+        this.app.booted(async () => {
+            this.router.get(`/${spaRoute}/favicon.svg`, (ctx) => {
+                return ctx.response.download(path.join(uiPath, 'favicon.svg'));
+            });
+            this.router.get(`/${spaRoute}`, (ctx) => {
+                return ctx.response.redirect(`/${spaRoute}/requests`);
+            });
+            this.router.get(`/${spaRoute}/*`, (ctx) => {
+                if (lensUtils.isStaticFile(ctx.params['*'])) {
+                    return this.matchStaticFiles(ctx, uiPath, lensUtils.stripBeforeAssetsPath(ctx.params['*'].join('/')));
+                }
+                const htmlPath = path.join(uiPath, 'index.html');
+                return ctx.response.download(htmlPath, true);
+            });
+        });
+    }
+    matchStaticFiles(ctx, uiPath, subPath) {
+        const assetPath = path.join(uiPath, subPath);
+        return ctx.response.download(assetPath);
+    }
+    async getUserFromContext(ctx) {
+        return (await this.config.isAuthenticated?.(ctx)) && this.config.getUser
+            ? await this.config.getUser?.(ctx)
+            : null;
+    }
+}

package/build/src/define_config.d.ts

@@ -0,0 +1,21 @@
+import { HttpContext } from '@adonisjs/core/http';
+import { QueryType, UserEntry } from '../../core/dist/types/index.js';
+type AdonisQueryType = Extract<QueryType, "postgresql" | "sqlite" | "mysql" | "mariadb" | "plsql" | "transactsql">;
+export type LensConfig = {
+    appName: string;
+    path: string;
+    enabled: boolean;
+    ignoredPaths: RegExp[];
+    onlyPaths: RegExp[];
+    watchers: {
+        queries: {
+            enabled: boolean;
+            provider: AdonisQueryType;
+        };
+        requests: boolean;
+    };
+    isAuthenticated?: (ctx: HttpContext) => Promise<boolean>;
+    getUser?: (ctx: HttpContext) => Promise<UserEntry>;
+};
+export declare function defineConfig(config: LensConfig): import("@adonisjs/core/types").ConfigProvider<LensConfig>;
+export {};

package/build/src/define_config.js

@@ -0,0 +1,6 @@
+import { configProvider } from '@adonisjs/core';
+export function defineConfig(config) {
+    return configProvider.create(async () => {
+        return config;
+    });
+}

package/build/src/utils/index.d.ts

@@ -0,0 +1,9 @@
+import type { ApplicationService } from '@adonisjs/core/types';
+import { HttpContext } from '@adonisjs/core/http';
+import { LensConfig } from '../define_config.js';
+export declare const runningInConsole: (app: ApplicationService) => boolean;
+export declare const getRunningCommand: () => string;
+export declare function allowedCommands(): boolean;
+export declare const shouldIgnoreLogging: (app: ApplicationService) => boolean;
+export declare const resolveConfigFromContext: (ctx: HttpContext) => Promise<LensConfig>;
+export declare function parseDuration(durationStr: string): number;

package/build/src/utils/index.js

@@ -0,0 +1,51 @@
+import chalk from 'chalk';
+export const runningInConsole = (app) => {
+    return ['console', 'repl', 'test'].includes(app.getEnvironment());
+};
+export const getRunningCommand = () => {
+    const cmd = process.env.ACE_CLI_COMMAND;
+    if (!cmd) {
+        const message = `
+${chalk.red.bold('✖ Could not determine running command')}
+
+Make sure to set the environment variable:
+
+  ${chalk.cyan("process.env.ACE_CLI_COMMAND = process.argv[2] ?? ''")}
+
+before creating a new Ignitor instance in:
+
+  ${chalk.yellow('start/server.ts')}
+    `;
+        throw new Error(message);
+    }
+    return cmd;
+};
+export function allowedCommands() {
+    const command = getRunningCommand();
+    return ['queue:listen', 'schedule:work'].includes(command ?? 'WRONG');
+}
+export const shouldIgnoreLogging = (app) => {
+    return runningInConsole(app) && !allowedCommands();
+};
+export const resolveConfigFromContext = async (ctx) => {
+    return await ctx.containerResolver.make('lensConfig');
+};
+export function parseDuration(durationStr) {
+    const [value, unit] = durationStr.trim().split(' ');
+    const num = parseFloat(value);
+    switch (unit) {
+        case 'ms':
+            return num;
+        case 's':
+            return num * 1000;
+        case 'μs':
+        case 'µs':
+            return num / 1000;
+        case 'ns':
+            return num / 1_000_000;
+        case 'min':
+            return num * 60_000;
+        default:
+            return 0;
+    }
+}

package/build/stubs/config/lens.stub

@@ -0,0 +1,40 @@
+{{{
+  exports({ to: app.configPath('lens.ts') })
+}}}
+import env from '#start/env'
+import { defineConfig } from '@lensjs/adonis'
+
+const lensConfig = defineConfig({
+  appName: env.get('APP_NAME', 'AdonisJs'),
+  enabled: env.get('LENS_ENABLED', true),
+  path: env.get('LENS_BASE_PATH', 'lens'),
+  ignoredPaths: [],
+  onlyPaths: [],
+  watchers: {
+    requests: env.get('LENS_ENABLE_REQUEST_WATCHER', true),
+    queries: {
+      enabled: env.get('LENS_ENABLE_QUERY_WATCHER', true),
+      provider: 'sqlite', // Change to your database provider
+    }
+  },
+  // Optional
+  isAuthenticated: async (ctx) => {
+    return await ctx.auth?.check()
+  },
+  // Optional
+  getUser: async (ctx) => {
+    const user = ctx.auth?.user
+
+    if (!user) {
+      return null
+    }
+
+    return {
+      id: user.$primaryKeyValue,
+      name: user.name,
+      email: user.email,
+    }
+  },
+})
+
+export default lensConfig

package/build/stubs/main.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Path to the root directory where the stubs are stored. We use
+ * this path within commands and the configure hook
+ */
+export declare const stubsRoot: string;

package/build/stubs/main.js

@@ -0,0 +1,7 @@
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+/**
+ * Path to the root directory where the stubs are stored. We use
+ * this path within commands and the configure hook
+ */
+export const stubsRoot = dirname(fileURLToPath(import.meta.url));

package/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "@lensjs/adonis",
+  "description": "AdonisJs adapter for lens package",
+  "version": "1.0.1",
+  "engines": {
+    "node": ">=20.6.0"
+  },
+  "type": "module",
+  "files": [
+    "build/src",
+    "build/providers",
+    "build/stubs",
+    "build/index.d.ts",
+    "build/index.js",
+    "build/configure.d.ts",
+    "build/configure.js"
+  ],
+  "exports": {
+    ".": "./build/index.js",
+    "./types": "./build/src/types.js",
+    "./lens_provider": "./build/providers/lens_service_provider.js",
+    "./lens_middleware": "./build/src/middlewares/lens_middleware.js"
+  },
+  "scripts": {
+    "clean": "del-cli build",
+    "copy:templates": "copyfiles \"stubs/**/*.stub\" build",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "format": "prettier --write .",
+    "quick:test": "node --import=./tsnode.esm.js --enable-source-maps bin/test.ts",
+    "pretest": "npm run lint",
+    "test": "c8 npm run quick:test",
+    "prebuild": "npm run clean",
+    "build": "tsc",
+    "postbuild": "npm run copy:templates",
+    "release": "np",
+    "version": "npm run build",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@adonisjs/assembler": "^7.8.2",
+    "@adonisjs/core": "^6.12.0",
+    "@adonisjs/eslint-config": "2.0.0-beta.7",
+    "@adonisjs/lucid": "^21.8.0",
+    "@adonisjs/prettier-config": "^1.4.0",
+    "@adonisjs/tsconfig": "^1.3.0",
+    "@japa/assert": "^3.0.0",
+    "@japa/runner": "^3.1.4",
+    "@swc/core": "^1.6.3",
+    "@types/node": "^20.14.5",
+    "c8": "^10.1.2",
+    "copyfiles": "^2.4.1",
+    "del-cli": "^5.1.0",
+    "eslint": "^9.15.0",
+    "np": "^10.0.6",
+    "prettier": "^3.3.2",
+    "ts-node-maintained": "^10.9.4",
+    "typescript": "^5.4.5"
+  },
+  "peerDependencies": {
+    "@adonisjs/core": "^6.2.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  },
+  "np": {
+    "message": "chore(release): %s",
+    "tag": "latest",
+    "branch": "main",
+    "anyBranch": false
+  },
+  "c8": {
+    "reporter": [
+      "text",
+      "html"
+    ],
+    "exclude": [
+      "tests/**"
+    ]
+  },
+  "prettier": "@adonisjs/prettier-config",
+  "gitHead": "54568656ae9332e499ee05b21cded9c0f7dd7e40"
+}