@nu-art/bug-report-backend 0.400.7

package/core/module-pack.d.ts

@@ -0,0 +1 @@
+export declare const ModulePack_Backend_BugReport: (import("../modules/ModuleBE_BugReport.js").ModuleBE_BugReport_Class | import("../modules/ModuleBE_AdminBR.js").ModuleBE_AdminBR_Class | import("../modules/JiraBugReportIntegrator.js").JiraBugReportIntegrator_Class | import("@nu-art/slack-backend").ModuleBE_Slack_Class | import("../modules/SlackBugReportIntegrator.js").SlackBugReportIntegrator_Class)[];

package/core/module-pack.js

@@ -0,0 +1,31 @@
+/*
+ * Allow the user to file a bug  report directly from your app
+ *
+ * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
+ *
+ * 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 { ModuleBE_BugReport } from '../modules/ModuleBE_BugReport.js';
+import { ModuleBE_AdminBR } from '../modules/ModuleBE_AdminBR.js';
+import { JiraBugReportIntegrator } from '../modules/JiraBugReportIntegrator.js';
+// import {JiraModule} from '@nu-art/jira-backend';
+import { SlackBugReportIntegrator } from '../modules/SlackBugReportIntegrator.js';
+import { ModuleBE_Slack } from '@nu-art/slack-backend';
+export const ModulePack_Backend_BugReport = [
+    ModuleBE_BugReport,
+    ModuleBE_AdminBR,
+    JiraBugReportIntegrator,
+    // JiraModule,
+    SlackBugReportIntegrator,
+    ModuleBE_Slack
+];

package/index.d.ts

@@ -0,0 +1,5 @@
+export * from './core/module-pack.js';
+export * from './modules/ModuleBE_AdminBR.js';
+export * from './modules/ModuleBE_BugReport.js';
+export * from './modules/JiraBugReportIntegrator.js';
+export * from './modules/SlackBugReportIntegrator.js';

package/index.js

@@ -0,0 +1,23 @@
+/*
+ * Permissions management system, define access level for each of
+ * your server apis, and restrict users by giving them access levels
+ *
+ * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
+ *
+ * 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 * from './core/module-pack.js';
+export * from './modules/ModuleBE_AdminBR.js';
+export * from './modules/ModuleBE_BugReport.js';
+export * from './modules/JiraBugReportIntegrator.js';
+export * from './modules/SlackBugReportIntegrator.js';

package/modules/JiraBugReportIntegrator.d.ts

@@ -0,0 +1,15 @@
+import { Module } from '@nu-art/ts-common';
+import { IssueType, JiraProject, LabelType } from '@nu-art/jira-backend';
+import { ReportLogFile, Request_BugReport, TicketDetails } from '@nu-art/bug-report-shared';
+type Config = {
+    jiraProject: JiraProject;
+    issueType: IssueType;
+    label: LabelType;
+};
+export declare class JiraBugReportIntegrator_Class extends Module<Config> {
+    setIssueTitleProcessor(parser: (name: string) => string): void;
+    private parser;
+    openTicket: (bugReport: Request_BugReport, logs: ReportLogFile[], reporter?: string) => Promise<TicketDetails | undefined>;
+}
+export declare const JiraBugReportIntegrator: JiraBugReportIntegrator_Class;
+export {};

package/modules/JiraBugReportIntegrator.js

@@ -0,0 +1,41 @@
+/*
+ * Allow the user to file a bug  report directly from your app
+ *
+ * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
+ *
+ * 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 { ImplementationMissingException, Module } from '@nu-art/ts-common';
+import { JiraModule } from '@nu-art/jira-backend';
+import { Platform_Jira } from '@nu-art/bug-report-shared';
+export class JiraBugReportIntegrator_Class extends Module {
+    setIssueTitleProcessor(parser) {
+        this.parser = parser;
+    }
+    parser = (name) => `Bug: ${name}`;
+    openTicket = async (bugReport, logs, reporter) => {
+        if (bugReport.platforms && !bugReport.platforms.includes(Platform_Jira))
+            return;
+        if (!this.config.jiraProject)
+            throw new ImplementationMissingException('missing Jira project in bug report configurations');
+        const description = logs.reduce((carry, log, i) => {
+            carry.push({ href: log.path, text: '\nClick to view logs (' + i + ')' });
+            return carry;
+        }, [bugReport.description]);
+        if (reporter)
+            description.push('\nReported by: ' + reporter);
+        const issue = await JiraModule.issue.create(this.config.jiraProject, this.config.issueType, this.parser(bugReport.subject), description, this.config.label.label);
+        return { platform: Platform_Jira, issueId: issue.url };
+    };
+}
+export const JiraBugReportIntegrator = new JiraBugReportIntegrator_Class();

package/modules/ModuleBE_AdminBR.d.ts

@@ -0,0 +1,20 @@
+import { Module } from '@nu-art/ts-common';
+import { DB_BugReport, Paths } from '@nu-art/bug-report-shared/api';
+type Config = {
+    projectId: string;
+    bucket?: string;
+};
+export declare class ModuleBE_AdminBR_Class extends Module<Config> {
+    private bugReport;
+    private storage;
+    constructor();
+    protected init(): void;
+    getFilesFirebase: () => Promise<DB_BugReport[]>;
+    downloadFiles: (path: Paths) => Promise<{
+        fileName: string;
+        signedUrl: string;
+        publicUrl: string;
+    }>;
+}
+export declare const ModuleBE_AdminBR: ModuleBE_AdminBR_Class;
+export {};

package/modules/ModuleBE_AdminBR.js

@@ -0,0 +1,47 @@
+/*
+ * Permissions management system, define access level for each of
+ * your server apis, and restrict users by giving them access levels
+ *
+ * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
+ *
+ * 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 { Module } from '@nu-art/ts-common';
+import { ApiDef_AdminBugReport } from '@nu-art/bug-report-shared/api';
+import { ModuleBE_Firebase } from '@nu-art/firebase-backend';
+import { addRoutes, createBodyServerApi, createQueryServerApi } from '@nu-art/thunderstorm-backend';
+export class ModuleBE_AdminBR_Class extends Module {
+    bugReport;
+    storage;
+    constructor() {
+        super();
+    }
+    init() {
+        super.init();
+        const sessAdmin = ModuleBE_Firebase.createAdminSession();
+        const firestore = sessAdmin.getFirestore();
+        this.bugReport = firestore.getCollection('bug-report', ['_id']);
+        this.storage = sessAdmin.getStorage();
+        addRoutes([
+            createBodyServerApi(ApiDef_AdminBugReport.v1.downloadLogs, ModuleBE_AdminBR.downloadFiles),
+            createQueryServerApi(ApiDef_AdminBugReport.v1.retrieveLogs, ModuleBE_AdminBR.getFilesFirebase),
+        ]);
+    }
+    getFilesFirebase = async () => this.bugReport.getAll();
+    downloadFiles = async (path) => {
+        const bucket = await this.storage.getOrCreateBucket(this.config?.bucket);
+        const file = await bucket.getFile(path.path);
+        return file.getReadSignedUrl(600000, 'application/zip');
+    };
+}
+export const ModuleBE_AdminBR = new ModuleBE_AdminBR_Class();

package/modules/ModuleBE_BugReport.d.ts

@@ -0,0 +1,20 @@
+import { Module } from '@nu-art/ts-common';
+import { BugReport, ReportLogFile, Request_BugReport, TicketDetails } from '@nu-art/bug-report-shared';
+type Config = {
+    projectId?: string;
+    bucket?: string;
+};
+type TicketCreatorApi = (bugReport: Request_BugReport, logs: ReportLogFile[], email?: string) => Promise<TicketDetails | undefined>;
+export declare class ModuleBE_BugReport_Class extends Module<Config> {
+    private bugReport;
+    private storage;
+    private ticketCreatorApis;
+    constructor();
+    protected init(): void;
+    private sendBugReport;
+    addTicketCreator(ticketCreator: TicketCreatorApi): void;
+    saveLog: (report: BugReport, id: string) => Promise<ReportLogFile>;
+    saveFile: (bugReport: Request_BugReport, email?: string) => Promise<TicketDetails[]>;
+}
+export declare const ModuleBE_BugReport: ModuleBE_BugReport_Class;
+export {};

package/modules/ModuleBE_BugReport.js

@@ -0,0 +1,81 @@
+/*
+ * Permissions management system, define access level for each of
+ * your server apis, and restrict users by giving them access levels
+ *
+ * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
+ *
+ * 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 { addItemToArray, auditBy, currentTimeMillis, filterInstances, generateHex, Module, padNumber } from '@nu-art/ts-common';
+import { ModuleBE_Firebase } from '@nu-art/firebase-backend';
+import { addRoutes, createBodyServerApi } from '@nu-art/thunderstorm-backend';
+import JSZip from 'jszip';
+import { ApiDef_BugReport } from '@nu-art/bug-report-shared';
+import { MemKey_AccountId } from '@nu-art/user-account-backend/_entity/session/index';
+export class ModuleBE_BugReport_Class extends Module {
+    bugReport;
+    storage;
+    ticketCreatorApis = [];
+    constructor() {
+        super();
+    }
+    init() {
+        const sessionAdmin = ModuleBE_Firebase.createAdminSession();
+        const firestore = sessionAdmin.getFirestore();
+        this.bugReport = firestore.getCollection('bug-report', ['_id']);
+        this.storage = sessionAdmin.getStorage();
+        addRoutes([
+            createBodyServerApi(ApiDef_BugReport.v1.sendBugReport, (body) => this.sendBugReport(body)),
+        ]);
+    }
+    sendBugReport = async (body) => {
+        return await ModuleBE_BugReport.saveFile(body, MemKey_AccountId.get());
+    };
+    addTicketCreator(ticketCreator) {
+        addItemToArray(this.ticketCreatorApis, ticketCreator);
+    }
+    saveLog = async (report, id) => {
+        const zip = new JSZip();
+        report.log.forEach((message, i) => zip.file(`${report.name}_${padNumber(i, 2)}.txt`, message));
+        const buffer = await zip.generateAsync({ type: 'nodebuffer' });
+        const bucket = await this.storage.getOrCreateBucket(this.config?.bucket);
+        const fileName = `${id}-${report.name}.zip`;
+        const file = await bucket.getFile(fileName);
+        await file.write(buffer);
+        return {
+            path: `https://storage.cloud.google.com/${file.file.metadata.bucket}/${file.file.metadata.name}`,
+            name: fileName
+        };
+    };
+    saveFile = async (bugReport, email) => {
+        const _id = generateHex(16);
+        const logs = await Promise.all(bugReport.reports.map(report => this.saveLog(report, _id)));
+        const now = currentTimeMillis();
+        const instance = {
+            _id,
+            __created: now,
+            __updated: now,
+            subject: bugReport.subject,
+            description: bugReport.description,
+            reports: logs,
+            _audit: auditBy(email || 'bug-report'),
+        };
+        if (this.config?.bucket)
+            instance.bucket = this.config.bucket;
+        const tickets = await Promise.all(this.ticketCreatorApis.map(api => api(bugReport, logs, email)));
+        instance.tickets = filterInstances(tickets);
+        await this.bugReport.insert(instance);
+        return instance.tickets;
+    };
+}
+export const ModuleBE_BugReport = new ModuleBE_BugReport_Class();

package/modules/SlackBugReportIntegrator.d.ts

@@ -0,0 +1,10 @@
+import { Module } from '@nu-art/ts-common';
+import { ReportLogFile, Request_BugReport, TicketDetails } from '@nu-art/bug-report-shared';
+type Config = {
+    channel: string;
+};
+export declare class SlackBugReportIntegrator_Class extends Module<Config> {
+    openTicket: (bugReport: Request_BugReport, logs: ReportLogFile[], reporter?: string) => Promise<TicketDetails | undefined>;
+}
+export declare const SlackBugReportIntegrator: SlackBugReportIntegrator_Class;
+export {};

package/modules/SlackBugReportIntegrator.js

@@ -0,0 +1,37 @@
+/*
+ * Permissions management system, define access level for each of
+ * your server apis, and restrict users by giving them access levels
+ *
+ * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
+ *
+ * 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 { generateHex, ImplementationMissingException, Module } from '@nu-art/ts-common';
+import { Platform_Slack } from '@nu-art/bug-report-shared';
+import { ModuleBE_Slack } from '@nu-art/slack-backend';
+export class SlackBugReportIntegrator_Class extends Module {
+    openTicket = async (bugReport, logs, reporter) => {
+        if (bugReport.platforms && !bugReport.platforms.includes(Platform_Slack))
+            return;
+        if (!this.config.channel)
+            throw new ImplementationMissingException('Missing Slack Channel in bug report configurations');
+        let description = logs.reduce((carry, log, i) => {
+            return carry + '\n' + `<${log.path}|Click to view logs (${i})>`;
+        }, bugReport.subject + '\n' + bugReport.description);
+        if (reporter)
+            description += '\nReported by: ' + reporter;
+        await ModuleBE_Slack.postMessage(description, this.config.channel);
+        return { platform: Platform_Slack, issueId: generateHex(32) };
+    };
+}
+export const SlackBugReportIntegrator = new SlackBugReportIntegrator_Class();

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@nu-art/bug-report-backend",
+  "version": "0.400.7",
+  "description": "Bug Report Backend",
+  "keywords": [
+    "TacB0sS",
+    "express",
+    "infra",
+    "bug-report",
+    "nu-art",
+    "thunderstorm",
+    "typescript"
+  ],
+  "homepage": "https://github.com/nu-art-js/bug-report",
+  "bugs": {
+    "url": "https://github.com/nu-art-js/bug-report/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com:nu-art-js/bug-report.git"
+  },
+  "publishConfig": {
+    "directory": "dist",
+    "linkDirectory": true
+  },
+  "license": "Apache-2.0",
+  "author": "TacB0sS",
+  "scripts": {
+    "build": "tsc"
+  },
+  "dependencies": {
+    "@nu-art/bug-report-shared": "0.400.7",
+    "@nu-art/firebase-backend": "0.400.7",
+    "@nu-art/firebase-shared": "0.400.7",
+    "@nu-art/jira-backend": "0.400.7",
+    "@nu-art/jira-shared": "0.400.7",
+    "@nu-art/slack-backend": "0.400.7",
+    "@nu-art/slack-shared": "0.400.7",
+    "@nu-art/thunderstorm-backend": "0.400.7",
+    "@nu-art/thunderstorm-shared": "0.400.7",
+    "@nu-art/ts-common": "0.400.7",
+    "@nu-art/user-account-backend": "0.400.7",
+    "@nu-art/user-account-shared": "0.400.7",
+    "express": "^4.18.2",
+    "firebase": "^11.9.0",
+    "firebase-admin": "13.4.0",
+    "jszip": "^3.3.0",
+    "moment": "^2.29.4",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "react-router-dom": "^6.9.0",
+    "request": "^2.88.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.17",
+    "@types/file-saver": "^2.0.1",
+    "@types/history": "^4.7.2",
+    "@types/jszip": "^3.1.7",
+    "@types/react": "^18.0.0",
+    "@types/request": "^2.48.1"
+  },
+  "unitConfig": {
+    "type": "typescript-lib"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js"
+    },
+    "./*": {
+      "types": "./*.d.ts",
+      "import": "./*.js"
+    }
+  }
+}