Skip to content

npmstat.js: add writeLastWeekNpmStat #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
veghdev merged 3 commits into from
Apr 30, 2022
Merged

npmstat.js: add writeLastWeekNpmStat #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fd95046
npmstat.js: add getLastWeekNpmStat
veghdev Apr 30, 2022
25541de
npmstat.js: add writeLastWeekNpmStat
veghdev Apr 30, 2022
89fb50c
README.md: update example
veghdev Apr 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ write-npmstat makes it easy to collect, filter and save npm statistics to csv fi

# Installation

write-npmstat requires `npm-stat-api`, `enum`, `csv-writer` and `csv-parser` packages.
write-npmstat requires `npm-stat-api`, `enum`, `csv-writer`, `csv-parser` and `node-fetch` packages.

```sh
npm install write-npmstat
Expand All @@ -27,6 +27,8 @@ writenpmstat.writeNpmStat("2021", "2022-03");

writenpmstat.datePeriod = "month";
writenpmstat.writeNpmStat("2022-01", "2022-04-15");

writenpmstat.writeLastWeekNpmStat();
```

Visit our [documentation](https://veghdev.github.io/write-npmstat/) site for code reference or
Expand Down
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@
"npm-stat-api": "^1.0.0",
"enum": "^3.0.0",
"csv-writer": "^1.6.0",
"csv-parser": "^3.0.0"
"csv-parser": "^3.0.0",
"node-fetch": "<3.0.0"
},
"devDependencies": {
"npm-run-all": "^4.1.5",
Expand Down
135 changes: 119 additions & 16 deletions src/npmstat.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ const npm = require("npm-stat-api");
const Enum = require("enum");
const csv = require("csv-parser");
const createCsvWriter = require("csv-writer").createArrayCsvWriter;
const fetch = require("node-fetch");

const StatDate = require("./statdate.js");

Expand Down Expand Up @@ -119,6 +120,16 @@ class WriteNpmStat {
});
}

/**
* Returns last week npm statistics for a package
* @returns {Promise} Promise object represents the last week npm statistics for a package
*/
getLastWeekNpmStat() {
return new Promise((resolve) => {
return resolve(this.#getLastWeekStat(100));
});
}

static getDays(startDate, endDate) {
const arr = [];
const dt = new Date(startDate);
Expand Down Expand Up @@ -151,6 +162,45 @@ class WriteNpmStat {
});
}

#getLastWeekStat(retryLimit, retryCount) {
retryLimit = retryLimit || Number.MAX_VALUE;
retryCount = Math.max(retryCount || 0, 0);
return fetch(
"https://api.npmjs.org/versions/" + this.#packageName + "/last-week"
)
.then((response) => {
if (response.status !== 200) {
throw new Error("response.status: " + response.status);
}
return new Promise((resolve) => {
response.json().then((response) => {
const responseObject = {};
const day = StatDate.formatStart(new Date());
for (const [key, value] of Object.entries(
response.downloads
)) {
const statKey = day + "_" + key;
const statValues = [];
statValues.push(day);
if (this.writePackageName) {
statValues.push(this.#packageName);
}
statValues.push(key);
statValues.push(value);
responseObject[statKey] = statValues;
}
return resolve(responseObject);
});
});
})
.catch((err) => {
if (retryCount < retryLimit) {
return this.#getLastWeekStat(retryLimit, retryCount + 1);
}
throw err;
});
}

/**
* Writes npm statistics for a package
* @param {string|null} [startDate] - start date of the statistics
Expand All @@ -173,28 +223,56 @@ class WriteNpmStat {
* <br>&nbsp;&nbsp; - "%Y-%m-%d", for example "2022-12-31", which means to be collected until "2022-12-31"
*
* <br>&nbsp;&nbsp; - undefined, which means to be collected until the actual day
* @param {string|null} [endDate=npmstat] - postfix of the csv file
* @param {string|null} [postfix=npmstat] - postfix of the csv file
* @returns {Promise} Promise object represents the npm statistics for a package
*/
writeNpmStat(startDate, endDate, postfix = "npmstat") {
return new Promise((resolve) => {
const lastWeek = false;
const stats = this.getNpmStat(startDate, endDate);
stats.then((stats) => {
const grouped = this.#groupStats(
lastWeek,
stats,
startDate,
endDate,
postfix
);
this.#mergeStats(grouped).then((merged) => {
this.#writeStats(merged);
this.#mergeStats(lastWeek, grouped).then((merged) => {
this.#writeStats(lastWeek, merged);
return resolve(merged);
});
});
});
}

#groupStats(stats, startDate, endDate, postfix) {
/**
* Writes last week npm statistics for a package
* @param {string|null} [postfix=lastweek_npmstat] - postfix of the csv file
* @returns {Promise} Promise object represents the last week npm statistics for a package
*/
writeLastWeekNpmStat(postfix = "lastweek_npmstat") {
return new Promise((resolve) => {
const lastWeek = true;
const stats = this.getLastWeekNpmStat();
stats.then((stats) => {
const day = StatDate.formatStart(new Date());
const grouped = this.#groupStats(
lastWeek,
stats,
day,
day,
postfix
);
this.#mergeStats(lastWeek, grouped).then((merged) => {
this.#writeStats(lastWeek, merged);
return resolve(merged);
});
});
});
}

#groupStats(lastWeek, stats, startDate, endDate, postfix) {
const statDate = new StatDate(startDate, endDate);
const days = WriteNpmStat.getDays(statDate.start, statDate.end);
const grouped = {};
Expand All @@ -212,9 +290,17 @@ class WriteNpmStat {
const prefix = day.substring(0, substring);
if (!initialized[prefix]) {
initialized[prefix] = true;
grouped[prefix + "_" + postfix + ".csv"] = [
[day, stats[day]],
];
grouped[prefix + "_" + postfix + ".csv"] = [];
}
if (lastWeek) {
for (const [key, value] of Object.entries(stats)) {
if (key.startsWith(day)) {
grouped[prefix + "_" + postfix + ".csv"].push([
key,
value,
]);
}
}
} else {
grouped[prefix + "_" + postfix + ".csv"].push([
day,
Expand All @@ -225,21 +311,29 @@ class WriteNpmStat {
} else {
grouped[postfix + ".csv"] = [];
days.forEach((day) => {
grouped[postfix + ".csv"].push([day, stats[day]]);
if (lastWeek) {
for (const [key, value] of Object.entries(stats)) {
if (key.startsWith(day)) {
grouped[postfix + ".csv"].push([key, value]);
}
}
} else {
grouped[postfix + ".csv"].push([day, stats[day]]);
}
});
}
return grouped;
}

#mergeStats(stats) {
#mergeStats(lastWeek, stats) {
return new Promise((resolve) => {
if (!this.mergeStoredData) {
return resolve(stats);
}
const csvFiles = {};
const csvFilesReady = [];
for (const [key, value] of Object.entries(stats)) {
const csvFileReady = this.#readCsv(key, value[0]);
const csvFileReady = this.#readCsv(lastWeek, key, value[0]);
csvFilesReady.push(csvFileReady);
csvFileReady.then((csvData) => {
Object.assign(csvFiles, csvData);
Expand All @@ -256,7 +350,7 @@ class WriteNpmStat {
});
}

#readCsv(csvFile, firstNewLine) {
#readCsv(lastWeek, csvFile, firstNewLine) {
return new Promise((resolve) => {
const csvData = {};
csvData[csvFile] = [];
Expand All @@ -273,13 +367,16 @@ class WriteNpmStat {
.pipe(csv())
.on("data", (row) => {
if (firstNewLine) {
if (row.date < firstNewLine[0]) {
if (row.date < firstNewLine[0].substring(0, 10)) {
const statKey = row.date;
const statValues = [];
statValues.push(row.date);
if (writePackageName) {
statValues.push(row.package);
}
if (lastWeek) {
statValues.push(row.version);
}
statValues.push(row.downloads);
csvData[csvFile].push([statKey, statValues]);
}
Expand All @@ -292,19 +389,25 @@ class WriteNpmStat {
});
}

#writeStats(stats) {
#writeStats(lastWeek, stats) {
if (this.outDir) {
fs.mkdir(this.outDir, { recursive: true }, (err) => {
if (err) {
throw err;
}
for (const [key, value] of Object.entries(stats)) {
const csvFilePath = this.outDir + "/" + key;
const header = ["date"];
if (this.writePackageName) {
header.push("package");
}
if (lastWeek) {
header.push("version");
}
header.push("downloads");
const csvWriter = createCsvWriter({
path: csvFilePath,
header: this.writePackageName
? ["date", "package", "downloads"]
: ["date", "downloads"],
header,
});
const postProcessedStats = [];
value.forEach((stat) => {
Expand Down