@prosopo/datasets-fs 0.2.11 → 0.2.13

package/src/commands/generateV2.ts

@@ -0,0 +1,235 @@
+import { CaptchaTypes, CaptchaWithoutId, Captchas, CaptchasContainerSchema, Item, RawSolution } from '@prosopo/types'
+import { Generate, ArgsSchema as GenerateArgsSchema } from './generate.js'
+import { ProsopoEnvError } from '@prosopo/common'
+import { at, get, lodash } from '@prosopo/util'
+import { blake2AsHex } from '@polkadot/util-crypto'
+import { z } from 'zod'
+import bcrypt from 'bcrypt'
+import cliProgress from 'cli-progress'
+import fs from 'fs'
+
+export const ArgsSchema = GenerateArgsSchema.extend({
+    minCorrect: z.number().optional(),
+    minIncorrect: z.number().optional(),
+    minLabelled: z.number().optional(),
+    maxLabelled: z.number().optional(),
+    count: z.number().optional(),
+})
+export type ArgsSchemaType = typeof ArgsSchema
+export type Args = z.infer<ArgsSchemaType>
+
+export class GenerateV2 extends Generate<ArgsSchemaType> {
+    #size = 0
+    #minCorrect = 0
+    #saltRounds = 10
+    #allowDuplicatesLabelled = false
+    #allowDuplicatesUnlabelled = false
+    #minIncorrect = 0
+    #minLabelled = 0
+    #maxLabelled = 0
+    #count = 0
+    #nCorrect = 0
+    #nIncorrect = 0
+    #nLabelled = 0
+    #nUnlabelled = 0
+    #target = ''
+    #targets: string[] = []
+    #targetItems: Item[] = []
+    #notTargetItems: Item[] = []
+
+    public override getArgSchema() {
+        return ArgsSchema
+    }
+
+    public override getDescription(): string {
+        return 'Generate distinct captchas producing captcha challenges comprising one or more rounds, mixing labelled and unlabelled data into a single round'
+    }
+
+    public override getOptions() {
+        return lodash().merge(super.getOptions(), {
+            count: {
+                number: true,
+                description: 'Number of captchas to generate',
+            },
+            minCorrect: {
+                number: true,
+                description: 'Minimum number of correct images in each captcha',
+            },
+            minIncorrect: {
+                number: true,
+                description: 'Minimum number of incorrect images in each captcha',
+            },
+            minLabelled: {
+                number: true,
+                description: 'Minimum number of labelled images in each captcha',
+            },
+            maxLabelled: {
+                number: true,
+                description: 'Maximum number of labelled images in each captcha',
+            },
+        })
+    }
+
+    private setupTarget(i: number) {
+        const _ = lodash()
+        if (this.targets.length <= 1) {
+            throw new ProsopoEnvError(
+                new Error(`not enough different labels in labelled data`),
+                'DATASET.NOT_ENOUGH_LABELS'
+            )
+        }
+
+        // uniformly sample targets
+        const target = at(this.targets, i % this.targets.length)
+        const notTargets = this.targets.filter((t) => t !== target)
+        // how many labelled images should be in the captcha?
+        const nLabelled = _.random(this.#minLabelled, this.#maxLabelled)
+        // how many correct labelled images should be in the captcha?
+        const maxCorrect = nLabelled - this.#minCorrect
+        const nCorrect = _.random(this.#minCorrect, maxCorrect)
+        const nIncorrect = nLabelled - nCorrect
+        const nUnlabelled = this.#size - nLabelled
+
+        const targetItems = get(this.labelToImages, target)
+        const notTargetItems: Item[] = notTargets.map((notTarget) => get(this.labelToImages, notTarget)).flat()
+
+        if (nUnlabelled > this.unlabelled.length) {
+            throw new ProsopoEnvError(new Error(`not enough unlabelled data`), 'DATASET.NOT_ENOUGH_IMAGES')
+        }
+        if (nCorrect > targetItems.length) {
+            throw new ProsopoEnvError(
+                new Error(`not enough images for target (${target})`),
+                'DATASET.NOT_ENOUGH_IMAGES'
+            )
+        }
+        if (nIncorrect > notTargetItems.length) {
+            throw new ProsopoEnvError(
+                new Error(`not enough non-matching images for target (${target})`),
+                'DATASET.NOT_ENOUGH_IMAGES'
+            )
+        }
+
+        this.#nCorrect = nCorrect
+        this.#nIncorrect = nIncorrect
+        this.#nLabelled = nLabelled
+        this.#nUnlabelled = nUnlabelled
+        this.#target = target
+        this.#targets = notTargets
+        this.#targetItems = targetItems
+        this.#notTargetItems = notTargetItems
+    }
+
+    public override async _run(args: Args) {
+        await super._run(args)
+
+        const outFile: string = args.output
+
+        // get lodash (with seeded rng)
+        const _ = lodash()
+
+        this.#size = args.size || 9
+        this.#minCorrect = args.minCorrect || 1
+        this.#saltRounds = 10
+        this.#allowDuplicatesLabelled = args.allowDuplicatesLabelled || args.allowDuplicates || false
+        this.#allowDuplicatesUnlabelled = args.allowDuplicatesUnlabelled || args.allowDuplicates || false
+        this.#minIncorrect = Math.max(args.minIncorrect || 1, 1) // at least 1 incorrect image
+        this.#minLabelled = this.#minCorrect + this.#minIncorrect // min incorrect + correct
+        this.#maxLabelled = Math.min(args.maxLabelled || this.#size, this.#size) // at least 1 labelled image
+        this.#count = args.count || 0
+
+        // the captcha contains n images. Each of these images are either labelled, being correct or incorrect against the target, or unlabelled. To construct one of these captchas, we need to decide how many of the images should be labelled vs unlabelled, and then how many of the labelled images should be correct vs incorrect
+        // in the traditional captcha, two rounds are produced, one with labelled images and the other with unlabelled images. This gives 18 images overall, 9 labels produced.
+        // the parameters for generation can regulate how many labels are collected vs how much of a test the captcha posses. E.g. 18 images could have 16 unlabelled and 2 labelled, or 2 unlabelled and 16 labelled. The former is a better test of the user being human, but the latter is a better for maximising label collection.
+        // if we focus on a single captcha round of 9 images, we must have at least 1 labelled correct image in the captcha for it to work, otherwise it's just a labelling phase, which normally isn't a problem but if we're treating these as tests for humanity too then we need some kind of test in there. (e.g. we abolish the labelled then unlabelled pattern of the challenge rounds in favour of mixing labelled and unlabelled data, but we then run a small chance of serving two completely unlabelled rounds if we don't set the min number of labelled images to 1 per captcha round)
+
+        const bar = new cliProgress.SingleBar({}, cliProgress.Presets.shades_classic)
+        bar.start(this.#count, 0)
+
+        // generate n captchas
+        const captchas: CaptchaWithoutId[] = []
+        for (let i = 0; i < this.#count; i++) {
+            bar.increment()
+            // this.logger.info(`generating captcha ${i + 1} of ${count}`)
+            this.setupTarget(i)
+
+            // get the correct items
+            const correctItems: Item[] = _.sampleSize(this.#targetItems, this.#nCorrect)
+
+            // get the incorrect items
+            const incorrectItems: Item[] = _.sampleSize(this.#notTargetItems, this.#nIncorrect)
+
+            // get the unlabelled items
+            const unlabelledItems = new Set<Item>()
+            while (unlabelledItems.size < this.#size - this.#nLabelled) {
+                // get a random image from the unlabelled data
+                const image = at(this.unlabelled, _.random(0, this.unlabelled.length - 1))
+                unlabelledItems.add(image)
+            }
+
+            const itemsConcat: Item[] = [...correctItems, ...incorrectItems, ...unlabelledItems]
+            let indices: number[] = [...Array(itemsConcat.length).keys()]
+            indices = _.shuffle(indices)
+            const items = indices
+                .map((i) => at(itemsConcat, i))
+                .map((item) => {
+                    return {
+                        data: item.data,
+                        hash: item.hash,
+                        type: item.type,
+                    }
+                })
+
+            // the first n indices are the correct items
+            const solution: RawSolution[] = indices
+                .map((index, i) => {
+                    return {
+                        pre: index, // the index of the item in the items array before shuffle
+                        post: i, // the index of the item in the shuffled array
+                    }
+                })
+                .filter((item) => item.pre < correctItems.length) // keep all items that were in the first n slots of the original item array - these were the correct items
+                .map((item) => {
+                    return item.post // return the index in the shuffled array
+                })
+
+            // the unlabelled indices were after the correct and incorrect
+            const unlabelledIndices: RawSolution[] = indices
+                .map((index, i) => {
+                    return {
+                        pre: index, // the index of the item in the items array before shuffle
+                        post: i, // the index of the item in the shuffled array
+                    }
+                })
+                .filter((item) => item.pre >= correctItems.length + incorrectItems.length) // keep all items that were in the first n slots of the original item array - these were the correct items
+                .map((item) => {
+                    return item.post // return the index in the shuffled array
+                })
+
+            const salt = blake2AsHex(bcrypt.genSaltSync(this.#saltRounds))
+            // create the captcha
+            const captcha: CaptchaWithoutId = {
+                salt,
+                target: this.#target,
+                items,
+                solution,
+                unlabelled: unlabelledIndices,
+            }
+            captchas.push(captcha)
+        }
+        bar.stop()
+
+        // write to file
+        const output: Captchas = {
+            captchas,
+            format: CaptchaTypes.SelectAll,
+        }
+
+        // verify the output
+        this.logger.info('verifying data')
+        CaptchasContainerSchema.parse(output)
+
+        this.logger.info(`writing data`)
+        fs.mkdirSync(args.output.split('/').slice(0, -1).join('/'), { recursive: true })
+        fs.writeFileSync(outFile, JSON.stringify(output, null, 4))
+    }
+}

package/src/commands/get.ts

@@ -0,0 +1,84 @@
+import { InputArgsSchema, InputCliCommand } from '../utils/input.js'
+import { get } from '@prosopo/util'
+import { lodash } from '@prosopo/util'
+import { z } from 'zod'
+import cliProgress from 'cli-progress'
+import fs from 'fs'
+
+export const ArgsSchema = InputArgsSchema.extend({})
+export type ArgsSchemaType = typeof ArgsSchema
+export type Args = z.infer<ArgsSchemaType>
+export class Get extends InputCliCommand<ArgsSchemaType> {
+    public override getArgSchema() {
+        return ArgsSchema
+    }
+
+    public override getOptions() {
+        return lodash().merge(super.getOptions(), {
+            input: {
+                description: 'JSON file containing urls under a "data" key',
+            },
+        })
+    }
+
+    public override async _run(args: Args) {
+        await super._run(args)
+        const bar = new cliProgress.SingleBar({}, cliProgress.Presets.shades_classic)
+
+        const list: string[] = []
+        const traverse = async (data: any) => {
+            if (data instanceof Array) {
+                for (let i = 0; i < data.length; i++) {
+                    data[i] = await traverse(data[i])
+                }
+            } else if (data instanceof Object) {
+                for (const key of Object.keys(data)) {
+                    if (key == 'data') {
+                        const value = get(data, key)
+                        const url = z.string().parse(value)
+                        list.push(url)
+                    } else {
+                        await traverse(get(data, key))
+                    }
+                }
+            }
+            return data
+        }
+
+        const file = args.input
+
+        // read the map file
+        const data: any = JSON.parse(fs.readFileSync(file, 'utf8'))
+        await traverse(data)
+
+        bar.start(list.length, 0)
+        for (const url of list) {
+            bar.increment()
+            if (url.startsWith('http')) {
+                try {
+                    const response = await fetch(url)
+                    if (!response.ok) {
+                        this.logger.error(`GET ${url} ${response.status} ${response.statusText}`)
+                    } else {
+                        this.logger.log(`GET ${url} OK`)
+                    }
+                } catch (err) {
+                    this.logger.error(err)
+                }
+            } else {
+                // resolve locally
+                try {
+                    fs.readFileSync(url)
+                    this.logger.log(`GET ${url} OK`)
+                } catch (err) {
+                    this.logger.error(`GET ${url} ${err}`)
+                }
+            }
+        }
+        bar.stop()
+    }
+
+    public override getDescription(): string {
+        return 'Test a GET request at image URLs'
+    }
+}

package/src/commands/labels.ts

@@ -0,0 +1,54 @@
+import { InputOutputArgsSchema as InputOutputArgsSchema, InputOutputCliCommand } from '../utils/inputOutput.js'
+import { LabelledDataSchema, LabelledItem } from '@prosopo/types'
+import { ProsopoEnvError } from '@prosopo/common'
+import { lodash } from '@prosopo/util'
+import { z } from 'zod'
+import fs from 'fs'
+
+export const ArgsSchema = InputOutputArgsSchema.extend({})
+export type ArgsSchemaType = typeof ArgsSchema
+export type Args = z.infer<ArgsSchemaType>
+
+export class Labels extends InputOutputCliCommand<ArgsSchemaType> {
+    public override getArgSchema() {
+        return ArgsSchema
+    }
+
+    public override getOptions() {
+        return lodash().merge(super.getOptions(), {
+            input: {
+                description: 'JSON file containing labelled data',
+            },
+            output: {
+                description: 'Where to put the JSON file containing labels',
+            },
+        })
+    }
+
+    public override async _run(args: Args) {
+        await super._run(args)
+
+        const file = args.input
+        if (!fs.existsSync(file)) {
+            throw new ProsopoEnvError(new Error(`file does not exist: ${file}`), 'FS.FILE_NOT_FOUND')
+        }
+
+        const labelled: LabelledItem[] = file
+            ? LabelledDataSchema.parse(JSON.parse(fs.readFileSync(file, 'utf8'))).items
+            : []
+
+        const labels = new Set<string>()
+        for (const item of labelled) {
+            labels.add(item.label)
+        }
+        const labelArray = Array.from(labels)
+        labelArray.sort()
+
+        fs.mkdirSync(args.output.split('/').slice(0, -1).join('/'), { recursive: true })
+        fs.writeFileSync(args.output, JSON.stringify({ labels: labelArray }, null, 4))
+    }
+
+    public override getDescription(): string {
+        return 'get all labels from some data'
+    }
+}

package/src/commands/relocate.ts

@@ -0,0 +1,83 @@
+import { InputOutputArgsSchema as InputOutputArgsSchema, InputOutputCliCommand } from '../utils/inputOutput.js'
+import { get, lodash } from '@prosopo/util'
+import { z } from 'zod'
+import fs from 'fs'
+
+export const ArgsSchema = InputOutputArgsSchema.extend({
+    from: z.string(),
+    to: z.string(),
+})
+export type ArgsSchemaType = typeof ArgsSchema
+export type Args = z.infer<ArgsSchemaType>
+
+export class Relocate extends InputOutputCliCommand<ArgsSchemaType> {
+    public override getArgSchema() {
+        return ArgsSchema
+    }
+
+    public override getOptions() {
+        return lodash().merge(super.getOptions(), {
+            input: {
+                description: 'A json file containing a list of objects with (at least) a url',
+            },
+            output: {
+                description: 'Where to write the new json file containing the new urls',
+            },
+            from: {
+                string: true,
+                demand: true,
+                description: 'The string to replace in the urls',
+            },
+            to: {
+                description: 'The string to substitute in the urls',
+                string: true,
+                demand: true,
+            },
+        })
+    }
+
+    public override async _run(args: Args) {
+        await super._run(args)
+
+        const replace = (data: unknown, from: string, to: string) => {
+            if (Array.isArray(data)) {
+                for (let i = 0; i < data.length; i++) {
+                    data[i] = replace(data[i], from, to)
+                }
+            } else if (typeof data === 'object') {
+                const obj = data as {
+                    [key: string]: unknown
+                }
+                for (const key of Object.keys(obj)) {
+                    if (key === 'data') {
+                        const value = get(obj, key)
+                        if (typeof value === 'string') {
+                            if (value.startsWith(from)) {
+                                this.logger.debug('replacing', value)
+                                obj[key] = to + value.slice(from.length)
+                                this.logger.debug('replaced', obj[key])
+                            }
+                        }
+                    } else {
+                        obj[key] = replace(obj[key], from, to)
+                    }
+                }
+            }
+            return data
+        }
+
+        const file: string = args.input
+        this.logger.log(`relocating data in ${file} from ${args.from} to ${args.to}`)
+        // read the file
+        let data = JSON.parse(fs.readFileSync(file, 'utf8'))
+        // replace the urls by recursively traversing the data
+        data = replace(data, args.from, args.to)
+        // write the file
+        fs.mkdirSync(args.output.split('/').slice(0, -1).join('/'), { recursive: true })
+        fs.writeFileSync(args.output, JSON.stringify(data, null, 4))
+    }
+
+    public override getDescription(): string {
+        return 'Relocate urls in a JSON file using string substitution'
+    }
+}

package/src/commands/resize.ts

@@ -0,0 +1,137 @@
+import { Data, DataSchema, Item } from '@prosopo/types'
+import { InputOutputArgsSchema as InputOutputArgsSchema, InputOutputCliCommand } from '../utils/inputOutput.js'
+import { ProsopoEnvError } from '@prosopo/common'
+import { blake2b } from '@noble/hashes/blake2b'
+import { lodash } from '@prosopo/util'
+import { u8aToHex } from '@polkadot/util'
+import { z } from 'zod'
+import cliProgress from 'cli-progress'
+import fs from 'fs'
+import sharp from 'sharp'
+
+export const ArgsSchema = InputOutputArgsSchema.extend({
+    size: z.number(),
+    square: z.boolean().optional(),
+})
+export type ArgsSchemaType = typeof ArgsSchema
+export type Args = z.infer<ArgsSchemaType>
+
+export class Resize extends InputOutputCliCommand<ArgsSchemaType> {
+    public override getArgSchema() {
+        return ArgsSchema
+    }
+
+    public override getOptions() {
+        return lodash().merge(super.getOptions(), {
+            input: {
+                description: 'JSON file containing a list of objects with (at least) a url',
+            },
+            output: {
+                description:
+                    'Where to put the output directory containing the map file and single directory of images. The map file will contain the new urls of the scaled images, new hashes and pass through any other information, e.g. labels.',
+            },
+            size: {
+                number: true,
+                description:
+                    'The dimension (height/width) of the scaled image. If the image is not square, the other dimension will be scaled to maintain the aspect ratio.',
+            },
+            square: {
+                boolean: true,
+                description:
+                    'If true, the image will be cropped to a square before scaling. If false, the image will be scaled to the given size, maintaining the aspect ratio.',
+            },
+        })
+    }
+
+    public override async _run(args: Args) {
+        await super._run(args)
+
+        const size = args.size
+        const square = args.square ?? false
+
+        const mapFile: string = args.input
+        if (!fs.existsSync(mapFile)) {
+            throw new ProsopoEnvError(new Error(`Map file does not exist: ${mapFile}`), 'FS.FILE_NOT_FOUND')
+        }
+        const outDir: string = args.output
+        const overwrite = args.overwrite || false
+        if (!overwrite && fs.existsSync(outDir)) {
+            throw new ProsopoEnvError(new Error(`Output directory already exists: ${outDir}`), 'FS.FILE_NOT_FOUND')
+        }
+
+        // create the output directory
+        const imgDir = `${outDir}/images`
+        fs.mkdirSync(imgDir, { recursive: true })
+
+        // read the map file
+        const inputItems: Item[] = DataSchema.parse(JSON.parse(fs.readFileSync(mapFile, 'utf8'))).items
+
+        // for each item
+        const bar = new cliProgress.SingleBar({}, cliProgress.Presets.shades_classic)
+        bar.start(inputItems.length, 0)
+        const outputItems: Item[] = []
+        for (const inputItem of inputItems) {
+            bar.increment()
+            // this.logger.log(`resizing ${inputItem.data}`)
+            // read the file
+            const img = fs.readFileSync(inputItem.data)
+            // resize the image
+            const resized = await sharp(img)
+                .resize({
+                    width: size,
+                    height: size,
+                    fit: square ? 'cover' : 'inside',
+                })
+                .removeAlpha() // remove the alpha channel
+                .toColorspace('srgb') // 8-bits per channel
+                .jpeg({
+                    quality: 75,
+                    chromaSubsampling: '4:2:0',
+                    optimiseCoding: true,
+                    trellisQuantisation: true,
+                    overshootDeringing: true,
+                    optimizeScans: true,
+                    quantisationTable: 3,
+                    force: true,
+                })
+            const tmpFilePath = `${imgDir}/tmp.jpg`
+            await resized.toFile(tmpFilePath)
+            // read the resized image
+            const resizedImg = fs.readFileSync(tmpFilePath)
+            // hash the image
+            const hash = blake2b(resizedImg)
+            const hex = u8aToHex(hash)
+            // move the image
+            const finalFilePath = `${imgDir}/${hex}.jpg`
+            fs.renameSync(tmpFilePath, finalFilePath)
+
+            // add the item to the output
+            const outputItem: Item = {
+                ...inputItem,
+                hash: hex,
+                data: fs.realpathSync(finalFilePath),
+            }
+            outputItems.push(outputItem)
+        }
+        bar.stop()
+
+        // write the map file
+        const outputMapFile = `${outDir}/data.json`
+
+        const data: Data = {
+            items: outputItems,
+        }
+
+        // verify the output
+        this.logger.info('verifying data')
+        DataSchema.parse(data)
+
+        this.logger.info(`writing data`)
+        fs.mkdirSync(args.output.split('/').slice(0, -1).join('/'), { recursive: true })
+        fs.writeFileSync(outputMapFile, JSON.stringify(data, null, 4))
+    }
+
+    public override getDescription(): string {
+        return 'Resize images to a given size'
+    }
+}

package/src/dummy.ts

@@ -0,0 +1,35 @@
+// generate some dummy data for testing the generate fns
+
+import { CaptchaItemTypes, Item, LabelledItem } from '@prosopo/types'
+import fs from 'fs'
+
+const nLabels = 4
+const nLabelledImages = 100
+const nUnlabelledImages = 100
+
+const labelledImages: LabelledItem[] = []
+const unlabelledImages: Item[] = []
+
+for (let i = 0; i < nLabelledImages; i++) {
+    const label = i % nLabels
+    labelledImages.push({
+        label: label.toString(),
+        data: `abc${i}`,
+        type: CaptchaItemTypes.Image,
+        hash: `abc${i}hash`,
+    })
+}
+
+for (let i = 0; i < nUnlabelledImages; i++) {
+    unlabelledImages.push({
+        data: `def${i}`,
+        type: CaptchaItemTypes.Image,
+        hash: `def${i}hash`,
+    })
+}
+
+fs.writeFileSync('labelled.json', JSON.stringify(labelledImages))
+fs.writeFileSync('unlabelled.json', JSON.stringify(unlabelledImages))
+fs.writeFileSync('labels.json', JSON.stringify(Array.from(Array(nLabels).keys()).map((x) => x.toString())))
+
+process.exit(0)

package/src/index.ts

@@ -0,0 +1,14 @@
+// Copyright 2021-2023 Prosopo (UK) Ltd.
+//
+// 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 './cli/cli.js'