@stryker-mutator/dashboard-data-access 0.14.1 → 0.14.2-pr-536.1

package/dist/src/errors/OptimisticConcurrencyError.d.ts

@@ -0,0 +1,3 @@
+export declare class OptimisticConcurrencyError extends Error {
+}
+//# sourceMappingURL=OptimisticConcurrencyError.d.ts.map

package/dist/src/errors/index.d.ts

@@ -0,0 +1,2 @@
+export * from './OptimisticConcurrencyError.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts

@@ -0,0 +1,6 @@
+export * from './models/index.js';
+export * from './mappers/index.js';
+export { MutationTestingReportService } from './services/MutationTestingReportService.js';
+export { RealTimeMutantsBlobService } from './services/RealTimeMutantsBlobService.js';
+export * from './errors/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/mappers/DashboardQuery.d.ts

@@ -0,0 +1,12 @@
+import { ModelClass } from './ModelClass.js';
+import { TableQuery } from 'azure-storage';
+export declare class DashboardQuery<TModel, TPartitionKeyFields extends keyof TModel, TRowKeyFields extends keyof TModel> {
+    protected ModelClass: ModelClass<TModel, TPartitionKeyFields, TRowKeyFields>;
+    private readonly whereConditions;
+    private constructor();
+    whereRowKeyNotEquals(rowKey: Pick<TModel, TRowKeyFields>): DashboardQuery<TModel, TPartitionKeyFields, TRowKeyFields>;
+    wherePartitionKeyEquals(partitionKey: Pick<TModel, TPartitionKeyFields>): DashboardQuery<TModel, TPartitionKeyFields, TRowKeyFields>;
+    static create<TModel, TPartitionKeyFields extends keyof TModel, TRowKeyFields extends keyof TModel>(ModelClass: ModelClass<TModel, TPartitionKeyFields, TRowKeyFields>): DashboardQuery<TModel, TPartitionKeyFields, TRowKeyFields>;
+    build(): TableQuery;
+}
+//# sourceMappingURL=DashboardQuery.d.ts.map

package/dist/src/mappers/Mapper.d.ts

@@ -0,0 +1,14 @@
+import { DashboardQuery } from './DashboardQuery.js';
+export interface Result<TModel> {
+    etag: string;
+    model: TModel;
+}
+export interface Mapper<TModel, TPartitionKeyFields extends keyof TModel, TRowKeyFields extends keyof TModel> {
+    createStorageIfNotExists(): Promise<void>;
+    insertOrMerge(model: TModel): Promise<void>;
+    insert(model: TModel): Promise<Result<TModel>>;
+    replace(model: TModel, etag: string): Promise<Result<TModel>>;
+    findOne(identifier: Pick<TModel, TPartitionKeyFields | TRowKeyFields>): Promise<Result<TModel> | null>;
+    findAll(query: DashboardQuery<TModel, TPartitionKeyFields, TRowKeyFields>): Promise<Result<TModel>[]>;
+}
+//# sourceMappingURL=Mapper.d.ts.map

package/dist/src/mappers/ModelClass.d.ts

@@ -0,0 +1,9 @@
+export interface ModelClass<TModel, TPartitionKeyFields extends keyof TModel, TRowKeyFields extends keyof TModel> {
+    new (): TModel;
+    createPartitionKey(entity: Pick<TModel, TPartitionKeyFields>): string;
+    createRowKey(entity: Pick<TModel, TRowKeyFields>): string | undefined;
+    identify(entity: Partial<TModel>, partitionKeyValue: string, rowKeyValue: string): void;
+    readonly persistedFields: ReadonlyArray<Exclude<keyof TModel, TRowKeyFields>>;
+    readonly tableName: string;
+}
+//# sourceMappingURL=ModelClass.d.ts.map

package/dist/src/mappers/MutationTestingResultMapper.d.ts

@@ -0,0 +1,17 @@
+import { BlobServiceAsPromised } from '../services/BlobServiceAsPromised.js';
+import { BlobService } from 'azure-storage';
+import * as schema from 'mutation-testing-report-schema';
+import { ReportIdentifier } from '@stryker-mutator/dashboard-common';
+/**
+ * The report json part of a mutation testing report is stored in blob storage
+ */
+export declare class MutationTestingResultMapper {
+    private readonly blobService;
+    private static readonly CONTAINER_NAME;
+    constructor(blobService?: BlobServiceAsPromised);
+    createStorageIfNotExists(): Promise<BlobService.ContainerResult>;
+    insertOrReplace(id: ReportIdentifier, result: schema.MutationTestResult | null): Promise<void>;
+    findOne(identifier: ReportIdentifier): Promise<schema.MutationTestResult | null>;
+    delete(id: ReportIdentifier): Promise<void>;
+}
+//# sourceMappingURL=MutationTestingResultMapper.d.ts.map

package/dist/src/mappers/TableStorageMapper.d.ts

@@ -0,0 +1,24 @@
+import TableServiceAsPromised from '../services/TableServiceAsPromised.js';
+import { Mapper, Result } from './Mapper.js';
+import { ModelClass } from './ModelClass.js';
+import { DashboardQuery } from './DashboardQuery.js';
+export default class TableStorageMapper<TModel extends object, TPartitionKeyFields extends keyof TModel, TRowKeyFields extends keyof TModel> implements Mapper<TModel, TPartitionKeyFields, TRowKeyFields> {
+    private readonly ModelClass;
+    private readonly tableService;
+    constructor(ModelClass: ModelClass<TModel, TPartitionKeyFields, TRowKeyFields>, tableService?: TableServiceAsPromised);
+    createStorageIfNotExists(): Promise<void>;
+    insertOrMerge(model: TModel): Promise<void>;
+    findOne(identity: Pick<TModel, TPartitionKeyFields | TRowKeyFields>): Promise<Result<TModel> | null>;
+    findAll(query?: DashboardQuery<TModel, TPartitionKeyFields, TRowKeyFields>): Promise<Result<TModel>[]>;
+    /**
+     * Replace an entity of a specific version (throws error otherwise)
+     * @param model The model to replace
+     * @param etag The etag (version id)
+     * @throws {OptimisticConcurrencyError}
+     */
+    replace(model: TModel, etag: string): Promise<Result<TModel>>;
+    insert(model: TModel): Promise<Result<TModel>>;
+    private toModel;
+    private toEntity;
+}
+//# sourceMappingURL=TableStorageMapper.d.ts.map

package/dist/src/mappers/factories.d.ts

@@ -0,0 +1,7 @@
+import { Mapper } from './Mapper.js';
+import { MutationTestingReport, Project } from '../models/index.js';
+export type MutationTestingReportMapper = Mapper<MutationTestingReport, 'projectName' | 'version', 'moduleName'>;
+export type ProjectMapper = Mapper<Project, 'owner', 'name'>;
+export declare function createMutationTestingReportMapper(): MutationTestingReportMapper;
+export declare function createProjectMapper(): ProjectMapper;
+//# sourceMappingURL=factories.d.ts.map

package/dist/src/mappers/index.d.ts

@@ -0,0 +1,4 @@
+export * from './factories.js';
+export * from './Mapper.js';
+export * from './DashboardQuery.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/models/MutationTestingReport.d.ts

@@ -0,0 +1,29 @@
+import { ReportIdentifier } from '@stryker-mutator/dashboard-common';
+export declare class MutationTestingReport implements ReportIdentifier {
+    /**
+     * The repo slug. /:provider/:owner/:name (could also have more components in the future, for example gitlab supports this)
+     * @example /github.com/stryker-mutator/mutation-testing-elements
+     */
+    projectName: string;
+    /**
+     * The branch, tag or git hash
+     * @example 'master', 'v1', '0d3af4840904c42dede7016f45b53718a617bbd8'
+     */
+    version: string;
+    /**
+     * Optional: the module
+     * For example 'schema'
+     */
+    moduleName: string | undefined;
+    /**
+     * Indicates whether this report is real-time.
+     */
+    realTime?: boolean;
+    mutationScore: number;
+    static createRowKey(identifier: Pick<MutationTestingReport, 'moduleName'>): string | undefined;
+    static createPartitionKey(identifier: Pick<MutationTestingReport, 'version' | 'projectName'>): string;
+    static identify(entity: Partial<MutationTestingReport>, partitionKeyValue: string, rowKeyValue: string): void;
+    static readonly persistedFields: readonly ["mutationScore"];
+    static readonly tableName = "MutationTestingReport";
+}
+//# sourceMappingURL=MutationTestingReport.d.ts.map

package/dist/src/models/Project.d.ts

@@ -0,0 +1,12 @@
+export declare class Project {
+    owner: string;
+    name: string;
+    enabled: boolean;
+    apiKeyHash: string;
+    static readonly persistedFields: readonly ["enabled", "apiKeyHash"];
+    static readonly tableName = "Project";
+    static createRowKey(identifier: Pick<Project, 'name'>): string;
+    static createPartitionKey(identifier: Pick<Project, 'owner'>): string;
+    static identify(entity: Partial<Project>, partitionKeyValue: string, rowKeyValue: string): void;
+}
+//# sourceMappingURL=Project.d.ts.map

package/dist/src/models/Timestamped.d.ts

@@ -0,0 +1,4 @@
+export interface Timestamped {
+    timestamp: string;
+}
+//# sourceMappingURL=Timestamped.d.ts.map

package/dist/src/models/index.d.ts

@@ -0,0 +1,4 @@
+export * from './MutationTestingReport.js';
+export * from './Project.js';
+export * from './Timestamped.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/services/BlobServiceAsPromised.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+import { BlobService } from 'azure-storage';
+export declare class BlobServiceAsPromised {
+    createContainerIfNotExists: (container: string, options: BlobService.CreateContainerOptions) => Promise<BlobService.ContainerResult>;
+    createBlockBlobFromText: (container: string, blob: string, text: string | Buffer, options: BlobService.CreateBlobRequestOptions) => Promise<BlobService.BlobResult>;
+    blobToText: (container: string, blob: string) => Promise<string>;
+    createAppendBlobFromText: (container: string, blob: string, text: string | Buffer) => Promise<BlobService.BlobResult>;
+    appendBlockFromText: (container: string, blob: string, text: string | Buffer) => Promise<BlobService.BlobResult>;
+    deleteBlobIfExists: (container: string, blob: string) => Promise<unknown>;
+    constructor(blobService?: BlobService);
+}
+//# sourceMappingURL=BlobServiceAsPromised.d.ts.map

package/dist/src/services/MutationTestingReportService.d.ts

@@ -0,0 +1,18 @@
+import { MutationTestResult } from 'mutation-testing-report-schema';
+import { MutationTestingResultMapper } from '../mappers/MutationTestingResultMapper.js';
+import { MutationTestingReportMapper } from '../mappers/index.js';
+import { MutationScoreOnlyResult, ReportIdentifier, Report, Logger } from '@stryker-mutator/dashboard-common';
+export declare class MutationTestingReportService {
+    private readonly resultMapper;
+    private readonly mutationScoreMapper;
+    constructor(resultMapper?: MutationTestingResultMapper, mutationScoreMapper?: MutationTestingReportMapper);
+    createStorageIfNotExists(): Promise<void>;
+    saveReport(id: ReportIdentifier, result: MutationScoreOnlyResult | MutationTestResult, logger: Logger): Promise<void>;
+    private aggregateProjectReport;
+    private tryAggregateProjectReport;
+    findOne(id: ReportIdentifier): Promise<Report | null>;
+    delete(id: ReportIdentifier): Promise<void>;
+    private insertOrMergeReport;
+    private calculateMutationScore;
+}
+//# sourceMappingURL=MutationTestingReportService.d.ts.map

package/dist/src/services/RealTimeMutantsBlobService.d.ts

@@ -0,0 +1,14 @@
+import { ReportIdentifier } from '@stryker-mutator/dashboard-common';
+import { BlobServiceAsPromised } from './BlobServiceAsPromised.js';
+import { MutantResult } from 'mutation-testing-report-schema';
+export declare class RealTimeMutantsBlobService {
+    #private;
+    private static readonly CONTAINER_NAME;
+    constructor(blobService?: BlobServiceAsPromised);
+    createStorageIfNotExists(): Promise<void>;
+    createReport(id: ReportIdentifier): Promise<void>;
+    appendToReport(id: ReportIdentifier, mutants: Array<Partial<MutantResult>>): Promise<void>;
+    getReport(id: ReportIdentifier): Promise<Array<Partial<MutantResult>>>;
+    delete(id: ReportIdentifier): Promise<void>;
+}
+//# sourceMappingURL=RealTimeMutantsBlobService.d.ts.map

package/dist/src/services/TableServiceAsPromised.d.ts

@@ -0,0 +1,32 @@
+import { TableService, TableQuery, common } from 'azure-storage';
+export type Entity<T, TKeyFields extends keyof T> = {
+    [K in Exclude<keyof T, TKeyFields>]: {
+        $: string;
+        _: T[K];
+    };
+} & EntityKey & EntityMetadata;
+export interface EntityKey {
+    PartitionKey: {
+        $: 'Edm.String';
+        _: string;
+    };
+    RowKey: {
+        $: 'Edm.String';
+        _: string;
+    };
+}
+export interface EntityMetadata {
+    ['.metadata']: {
+        etag: string;
+    };
+}
+export default class TableServiceAsPromised {
+    constructor(tableService?: TableService);
+    insertEntity: (table: string, entityDescriptor: unknown, options: common.RequestOptions) => Promise<TableService.EntityMetadata>;
+    replaceEntity: (table: string, entityDescriptor: unknown, options: common.RequestOptions) => Promise<TableService.EntityMetadata>;
+    createTableIfNotExists: (name: string) => Promise<TableService.TableResult>;
+    queryEntities: <T, Keys extends keyof T>(table: string, tableQuery: TableQuery, cancellationToken: TableService.TableContinuationToken | undefined) => Promise<TableService.QueryEntitiesResult<Entity<T, Keys> & EntityKey>>;
+    insertOrMergeEntity: (table: string, entity: any) => Promise<TableService.EntityMetadata>;
+    retrieveEntity: <TResult>(table: string, partitionKey: string, rowKey: string, options?: TableService.TableEntityRequestOptions) => Promise<TResult>;
+}
+//# sourceMappingURL=TableServiceAsPromised.d.ts.map

package/dist/src/utils.d.ts

@@ -0,0 +1,7 @@
+import { ReportIdentifier } from '@stryker-mutator/dashboard-common';
+import { StorageError } from 'azure-storage';
+export declare function encodeKey(inputWithSlashes: string): string;
+export declare function decodeKey(inputWithSemiColons: string): string;
+export declare function isStorageError(maybeStorageError: unknown): maybeStorageError is StorageError;
+export declare function toBlobName({ projectName, version, moduleName, realTime, }: ReportIdentifier): string;
+//# sourceMappingURL=utils.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryker-mutator/dashboard-data-access",
-  "version": "0.14.1",
+  "version": "0.14.2-pr-536.1",
   "type": "module",
   "description": "This package contains the data access layer of the stryker dashboard application.",
   "scripts": {
@@ -21,10 +21,10 @@
   "typings": "src/index.ts",
   "license": "ISC",
   "dependencies": {
-    "@stryker-mutator/dashboard-common": "0.14.1",
+    "@stryker-mutator/dashboard-common": "0.14.2-pr-536.1",
     "azure-storage": "2.10.7",
     "mutation-testing-metrics": "3.0.2",
     "mutation-testing-report-schema": "3.0.2"
   },
-  "gitHead": "679afa76e9281bb4d641764a2bdc15a450fab9b8"
+  "gitHead": "6b70cbe421a22e4e7ed570c0ed69852e1ed5efda"
 }