@grnsft/if-github-plugin
Version:
Github plugin for Impact Framework.
87 lines • 11.4 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.Github = void 0;
const zod_1 = require("zod");
const interfaces_1 = require("@grnsft/if-core/interfaces");
const utils_1 = require("@grnsft/if-core/utils");
const api_1 = require("./api");
const { ConfigError } = utils_1.ERRORS;
exports.Github = (0, interfaces_1.PluginFactory)({
metadata: {
inputs: {},
outputs: {
clones: {
description: 'the clones count of the given repository in the specified time range',
unit: 'number',
'aggregation-method': { time: 'sum', component: 'sum' },
},
size: {
description: 'the size of the given repository',
unit: 'GB',
'aggregation-method': { time: 'sum', component: 'sum' },
},
},
},
implementation: async (inputs, config) => {
const { repo } = config;
const { clones, size } = await getRepoData(repo);
return inputs.map(input => ({
...input,
clones: getClonesForTimeRange(input, clones),
size,
}));
},
inputValidation: (input, _config, index) => {
const schema = zod_1.z.object({
timestamp: zod_1.z.string().or(zod_1.z.date()),
duration: zod_1.z.number().or(zod_1.z.string()),
});
return (0, utils_1.validate)(schema, input, index);
},
configValidation: (config) => {
if (!config || !Object.keys(config)?.length) {
throw new ConfigError('Config is not provided.');
}
const schema = zod_1.z.object({
repo: zod_1.z.string().regex(/^[a-zA-Z0-9_-]+\/[a-zA-Z0-9._-]+$/),
});
return (0, utils_1.validate)(schema, config);
},
});
/**
* Gets repo data from the GitHub API.
*/
const getRepoData = async (repo) => {
const [owner, repoName] = repo.split('/');
return await (0, api_1.GithubAPI)().getRepoClonesAndSizes(owner, repoName);
};
/**
* Gets clones count for the given input data.
*/
const getClonesForTimeRange = (input, clones) => {
const twoWeeksInMilliseconds = 14 * 24 * 60 * 60 * 1000;
const { timestamp, duration } = input;
const evaledDuration = eval(duration) * 1000;
const convertedTimestamp = localToUTC(timestamp);
const startTime = new Date(convertedTimestamp || timestamp).getTime();
const endTime = startTime + evaledDuration;
if (evaledDuration > twoWeeksInMilliseconds) {
console.warn('The `duration` exceeds two weeks. The GitHub API provides a maximum of 2 weeks of data. The plugin calculated data for two weeks.\n');
}
return clones.reduce((totalCount, clone) => {
const cloneTime = new Date(clone.timestamp).getTime();
if (cloneTime >= startTime && cloneTime <= endTime) {
return totalCount + clone.count;
}
return totalCount;
}, 0);
};
/**
* Converts a local time to an ISO string in UTC format.
*/
const localToUTC = (timestamp) => {
const date = new Date(timestamp);
const utcDate = new Date(date.getTime() + date.getTimezoneOffset() * 60000);
return utcDate.toISOString();
};
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/lib/index.ts"],"names":[],"mappings":";;;AAAA,6BAAsB;AAGtB,2DAAyD;AACzD,iDAAuD;AAEvD,+BAAgC;AAEhC,MAAM,EAAC,WAAW,EAAC,GAAG,cAAM,CAAC;AAEhB,QAAA,MAAM,GAAG,IAAA,0BAAa,EAAC;IAClC,QAAQ,EAAE;QACR,MAAM,EAAE,EAAE;QACV,OAAO,EAAE;YACP,MAAM,EAAE;gBACN,WAAW,EACT,sEAAsE;gBACxE,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,EAAC,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAC;aACtD;YACD,IAAI,EAAE;gBACJ,WAAW,EAAE,kCAAkC;gBAC/C,IAAI,EAAE,IAAI;gBACV,oBAAoB,EAAE,EAAC,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAC;aACtD;SACF;KACF;IACD,cAAc,EAAE,KAAK,EAAE,MAAsB,EAAE,MAAoB,EAAE,EAAE;QACrE,MAAM,EAAC,IAAI,EAAC,GAAG,MAAM,CAAC;QACtB,MAAM,EAAC,MAAM,EAAE,IAAI,EAAC,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,CAAC;QAE/C,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC1B,GAAG,KAAK;YACR,MAAM,EAAE,qBAAqB,CAAC,KAAK,EAAE,MAAM,CAAC;YAC5C,IAAI;SACL,CAAC,CAAC,CAAC;IACN,CAAC;IACD,eAAe,EAAE,CACf,KAAmB,EACnB,OAAqB,EACrB,KAAa,EACb,EAAE;QACF,MAAM,MAAM,GAAG,OAAC,CAAC,MAAM,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,OAAC,CAAC,IAAI,EAAE,CAAC;YAClC,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;SACpC,CAAC,CAAC;QAEH,OAAO,IAAA,gBAAQ,EAAyB,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAChE,CAAC;IACD,gBAAgB,EAAE,CAAC,MAAoB,EAAE,EAAE;QACzC,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;YAC5C,MAAM,IAAI,WAAW,CAAC,yBAAyB,CAAC,CAAC;QACnD,CAAC;QAED,MAAM,MAAM,GAAG,OAAC,CAAC,MAAM,CAAC;YACtB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,mCAAmC,CAAC;SAC5D,CAAC,CAAC;QAEH,OAAO,IAAA,gBAAQ,EAAyB,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;CACF,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,WAAW,GAAG,KAAK,EAAE,IAAY,EAAE,EAAE;IACzC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAE1C,OAAO,MAAM,IAAA,eAAS,GAAE,CAAC,qBAAqB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AAClE,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,qBAAqB,GAAG,CAC5B,KAAmB,EACnB,MAA4C,EAC5C,EAAE;IACF,MAAM,sBAAsB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IACxD,MAAM,EAAC,SAAS,EAAE,QAAQ,EAAC,GAAG,KAAK,CAAC;IACpC,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAC7C,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;IACjD,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,kBAAkB,IAAI,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC;IACtE,MAAM,OAAO,GAAG,SAAS,GAAG,cAAc,CAAC;IAE3C,IAAI,cAAc,GAAG,sBAAsB,EAAE,CAAC;QAC5C,OAAO,CAAC,IAAI,CACV,qIAAqI,CACtI,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE;QACzC,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC;QAEtD,IAAI,SAAS,IAAI,SAAS,IAAI,SAAS,IAAI,OAAO,EAAE,CAAC;YACnD,OAAO,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC;QAClC,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC,EAAE,CAAC,CAAC,CAAC;AACR,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,GAAG,CAAC,SAAiB,EAAU,EAAE;IAC/C,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC;IACjC,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,iBAAiB,EAAE,GAAG,KAAK,CAAC,CAAC;IAE5E,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC;AAC/B,CAAC,CAAC","sourcesContent":["import {z} from 'zod';\n\nimport {PluginParams, ConfigParams} from '@grnsft/if-core/types';\nimport {PluginFactory} from '@grnsft/if-core/interfaces';\nimport {ERRORS, validate} from '@grnsft/if-core/utils';\n\nimport {GithubAPI} from './api';\n\nconst {ConfigError} = ERRORS;\n\nexport const Github = PluginFactory({\n  metadata: {\n    inputs: {},\n    outputs: {\n      clones: {\n        description:\n          'the clones count of the given repository in the specified time range',\n        unit: 'number',\n        'aggregation-method': {time: 'sum', component: 'sum'},\n      },\n      size: {\n        description: 'the size of the given repository',\n        unit: 'GB',\n        'aggregation-method': {time: 'sum', component: 'sum'},\n      },\n    },\n  },\n  implementation: async (inputs: PluginParams[], config: ConfigParams) => {\n    const {repo} = config;\n    const {clones, size} = await getRepoData(repo);\n\n    return inputs.map(input => ({\n      ...input,\n      clones: getClonesForTimeRange(input, clones),\n      size,\n    }));\n  },\n  inputValidation: (\n    input: PluginParams,\n    _config: ConfigParams,\n    index: number\n  ) => {\n    const schema = z.object({\n      timestamp: z.string().or(z.date()),\n      duration: z.number().or(z.string()),\n    });\n\n    return validate<z.infer<typeof schema>>(schema, input, index);\n  },\n  configValidation: (config: ConfigParams) => {\n    if (!config || !Object.keys(config)?.length) {\n      throw new ConfigError('Config is not provided.');\n    }\n\n    const schema = z.object({\n      repo: z.string().regex(/^[a-zA-Z0-9_-]+\\/[a-zA-Z0-9._-]+$/),\n    });\n\n    return validate<z.infer<typeof schema>>(schema, config);\n  },\n});\n\n/**\n * Gets repo data from the GitHub API.\n */\nconst getRepoData = async (repo: string) => {\n  const [owner, repoName] = repo.split('/');\n\n  return await GithubAPI().getRepoClonesAndSizes(owner, repoName);\n};\n\n/**\n * Gets clones count for the given input data.\n */\nconst getClonesForTimeRange = (\n  input: PluginParams,\n  clones: {timestamp: string; count: number}[]\n) => {\n  const twoWeeksInMilliseconds = 14 * 24 * 60 * 60 * 1000;\n  const {timestamp, duration} = input;\n  const evaledDuration = eval(duration) * 1000;\n  const convertedTimestamp = localToUTC(timestamp);\n  const startTime = new Date(convertedTimestamp || timestamp).getTime();\n  const endTime = startTime + evaledDuration;\n\n  if (evaledDuration > twoWeeksInMilliseconds) {\n    console.warn(\n      'The `duration` exceeds two weeks. The GitHub API provides a maximum of 2 weeks of data. The plugin calculated data for two weeks.\\n'\n    );\n  }\n\n  return clones.reduce((totalCount, clone) => {\n    const cloneTime = new Date(clone.timestamp).getTime();\n\n    if (cloneTime >= startTime && cloneTime <= endTime) {\n      return totalCount + clone.count;\n    }\n\n    return totalCount;\n  }, 0);\n};\n\n/**\n * Converts a local time to an ISO string in UTC format.\n */\nconst localToUTC = (timestamp: string): string => {\n  const date = new Date(timestamp);\n  const utcDate = new Date(date.getTime() + date.getTimezoneOffset() * 60000);\n\n  return utcDate.toISOString();\n};\n"]}