Skip to content
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

feat: making the docs command recursive by default #343

Merged
merged 4 commits into from
Jul 28, 2021
Merged

feat: making the docs command recursive by default #343

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ea3e87a
feat: making the docs command recursive by default
erunion Jul 27, 2021
dcdb032
test: fixing some broken tests, adding one for recursive doc searching
erunion Jul 27, 2021
7343db7
test: cleaning up the docs test a bit
erunion Jul 27, 2021
c95aac8
fix: removing unnecessary filename rewriting logic
erunion Jul 28, 2021
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
1 change: 1 addition & 0 deletions __tests__/.eslintrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
{
"assertFunctionNames": [
"expect",
"getNockWithVersionHeader.**.reply",
"nock.**.reply"
]
}
Expand Down
4 changes: 4 additions & 0 deletions __tests__/__fixtures__/existing-docs/subdir/another-doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: This is another document title
---
Another body
225 changes: 108 additions & 117 deletions __tests__/cmds/docs.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,22 @@ const docs = require('../../src/cmds/docs');
const docsEdit = require('../../src/cmds/docs/edit');

const fixturesDir = `${__dirname}./../__fixtures__`;
const key = 'Xmw4bGctRVIQz7R7dQXqH9nQe5d0SPQs';
const key = 'API_KEY';
const version = '1.0.0';
const category = 'CATEGORY_ID';
const apiSetting = 'API_SETTING_ID';

function getNockWithVersionHeader(v) {
return nock(config.host, {
reqheaders: {
'x-readme-version': v,
},
});
}

function hashFileContents(contents) {
return crypto.createHash('sha1').update(contents).digest('hex');
}

describe('rdme docs', () => {
beforeAll(() => nock.disableNetConnect());
Expand Down Expand Up @@ -39,64 +53,84 @@ describe('rdme docs', () => {
it.todo('should error if the folder contains no markdown files');

describe('existing docs', () => {
let simpleDoc;
let anotherDoc;

beforeEach(() => {
let fileContents = fs.readFileSync(path.join(fixturesDir, `/existing-docs/simple-doc.md`));
simpleDoc = {
slug: 'simple-doc',
doc: frontMatter(fileContents),
hash: hashFileContents(fileContents),
};

fileContents = fs.readFileSync(path.join(fixturesDir, `/existing-docs/subdir/another-doc.md`));
anotherDoc = {
slug: 'another-doc',
doc: frontMatter(fileContents),
hash: hashFileContents(fileContents),
};
});
erunion marked this conversation as resolved.
Show resolved Hide resolved

it('should fetch doc and merge with what is returned', () => {
const slug = 'simple-doc';
const doc = frontMatter(fs.readFileSync(path.join(fixturesDir, `/existing-docs/${slug}.md`)));
const hash = crypto
.createHash('sha1')
.update(fs.readFileSync(path.join(fixturesDir, `/existing-docs/${slug}.md`)))
.digest('hex');

const getMock = nock(config.host, {
reqheaders: {
'x-readme-version': version,
},
})
.get(`/api/v1/docs/${slug}`)
.basicAuth({ user: key })
.reply(200, { category: '5ae9ece93a685f47efb9a97c', slug });
expect.assertions(1);

const putMock = nock(config.host, {
reqheaders: {
'x-readme-version': version,
},
})
.put(`/api/v1/docs/${slug}`, {
category: '5ae9ece93a685f47efb9a97c',
slug,
body: doc.content,
lastUpdatedHash: hash,
...doc.data,
const getMocks = getNockWithVersionHeader(version)
.get(`/api/v1/docs/simple-doc`)
.basicAuth({ user: key })
.reply(200, { category, slug: simpleDoc.slug, lastUpdatedHash: 'anOldHash' })
.get(`/api/v1/docs/another-doc`)
.basicAuth({ user: key })
.reply(200, { category, slug: anotherDoc.slug, lastUpdatedHash: 'anOldHash' });

const updateMocks = getNockWithVersionHeader(version)
.put('/api/v1/docs/simple-doc', {
category,
slug: simpleDoc.slug,
body: simpleDoc.doc.content,
lastUpdatedHash: simpleDoc.hash,
...simpleDoc.doc.data,
})
.basicAuth({ user: key })
.reply(200)
.put('/api/v1/docs/another-doc', {
category,
slug: anotherDoc.slug,
body: anotherDoc.doc.content,
lastUpdatedHash: anotherDoc.hash,
...anotherDoc.doc.data,
})
.basicAuth({ user: key })
.reply(200);

return docs.run({ folder: './__tests__/__fixtures__/existing-docs', key, version }).then(() => {
getMock.done();
putMock.done();
return docs.run({ folder: './__tests__/__fixtures__/existing-docs', key, version }).then(skippedDocs => {
// All docs should have been updated because their hashes from the GET request were different from what they
// are currently.
expect(skippedDocs).toHaveLength(0);

getMocks.done();
updateMocks.done();
});
});

it('should not send requests for docs that have not changed', () => {
expect.assertions(1);
const slug = 'simple-doc';
const hash = crypto
.createHash('sha1')
.update(fs.readFileSync(path.join(fixturesDir, `/existing-docs/${slug}.md`)))
.digest('hex');

const getMock = nock(config.host, {
reqheaders: {
'x-readme-version': version,
},
})
.get(`/api/v1/docs/${slug}`)

const getMocks = getNockWithVersionHeader(version)
.get('/api/v1/docs/simple-doc')
.basicAuth({ user: key })
.reply(200, { category, slug: simpleDoc.slug, lastUpdatedHash: simpleDoc.hash })
.get('/api/v1/docs/another-doc')
.basicAuth({ user: key })
.reply(200, { category: '5ae9ece93a685f47efb9a97c', slug, lastUpdatedHash: hash });
.reply(200, { category, slug: anotherDoc.slug, lastUpdatedHash: anotherDoc.hash });

return docs.run({ folder: './__tests__/__fixtures__/existing-docs', key, version }).then(([message]) => {
expect(message).toBe('`simple-doc` not updated. No changes.');
getMock.done();
return docs.run({ folder: './__tests__/__fixtures__/existing-docs', key, version }).then(skippedDocs => {
expect(skippedDocs).toStrictEqual([
'`simple-doc` was not updated because there were no changes.',
'`another-doc` was not updated because there were no changes.',
]);

getMocks.done();
});
});
});
Expand All @@ -105,16 +139,9 @@ describe('rdme docs', () => {
it('should create new doc', () => {
const slug = 'new-doc';
const doc = frontMatter(fs.readFileSync(path.join(fixturesDir, `/new-docs/${slug}.md`)));
const hash = crypto
.createHash('sha1')
.update(fs.readFileSync(path.join(fixturesDir, `/new-docs/${slug}.md`)))
.digest('hex');

const getMock = nock(config.host, {
reqheaders: {
'x-readme-version': version,
},
})
const hash = hashFileContents(fs.readFileSync(path.join(fixturesDir, `/new-docs/${slug}.md`)));

const getMock = getNockWithVersionHeader(version)
.get(`/api/v1/docs/${slug}`)
.basicAuth({ user: key })
.reply(404, {
Expand All @@ -124,11 +151,7 @@ describe('rdme docs', () => {
help: 'If you need help, email [email protected] and mention log "fake-metrics-uuid".',
});

const postMock = nock(config.host, {
reqheaders: {
'x-readme-version': version,
},
})
const postMock = getNockWithVersionHeader(version)
.post(`/api/v1/docs`, { slug, body: doc.content, ...doc.data, lastUpdatedHash: hash })
.basicAuth({ user: key })
.reply(201);
Expand All @@ -142,39 +165,25 @@ describe('rdme docs', () => {
it('should create only valid docs', () => {
console.log = jest.fn();
expect.assertions(2);

const slug = 'fail-doc';
const slugTwo = 'new-doc';

const doc = frontMatter(fs.readFileSync(path.join(fixturesDir, `/failure-docs/${slug}.md`)));
const docTwo = frontMatter(fs.readFileSync(path.join(fixturesDir, `/failure-docs/${slugTwo}.md`)));
const hash = crypto
.createHash('sha1')
.update(fs.readFileSync(path.join(fixturesDir, `/failure-docs/${slug}.md`)))
.digest('hex');

const hashTwo = crypto
.createHash('sha1')
.update(fs.readFileSync(path.join(fixturesDir, `/failure-docs/${slugTwo}.md`)))
.digest('hex');

const getMock = nock(config.host, {
reqheaders: {
'x-readme-version': version,
},
})

const hash = hashFileContents(fs.readFileSync(path.join(fixturesDir, `/failure-docs/${slug}.md`)));
const hashTwo = hashFileContents(fs.readFileSync(path.join(fixturesDir, `/failure-docs/${slugTwo}.md`)));

const getMocks = getNockWithVersionHeader(version)
.get(`/api/v1/docs/${slug}`)
.basicAuth({ user: key })
.reply(404, {
error: 'DOC_NOTFOUND',
message: `The doc with the slug '${slug}' couldn't be found`,
suggestion: '...a suggestion to resolve the issue...',
help: 'If you need help, email [email protected] and mention log "fake-metrics-uuid".',
});

const getMockTwo = nock(config.host, {
reqheaders: {
'x-readme-version': version,
},
})
})
.get(`/api/v1/docs/${slugTwo}`)
.basicAuth({ user: key })
.reply(404, {
Expand All @@ -184,24 +193,14 @@ describe('rdme docs', () => {
help: 'If you need help, email [email protected] and mention log "fake-metrics-uuid".',
});

const postMock = nock(config.host, {
reqheaders: {
'x-readme-version': version,
},
})
.post(`/api/v1/docs`, { slug, body: doc.content, ...doc.data, lastUpdatedHash: hash })
const postMocks = getNockWithVersionHeader(version)
.post('/api/v1/docs', { slug, body: doc.content, ...doc.data, lastUpdatedHash: hash })
.basicAuth({ user: key })
.reply(400, {
error: 'DOC_INVALID',
message: "We couldn't save this doc (Path `category` is required.).",
});

const postMockTwo = nock(config.host, {
reqheaders: {
'x-readme-version': version,
},
})
.post(`/api/v1/docs`, { slug: slugTwo, body: docTwo.content, ...docTwo.data, lastUpdatedHash: hashTwo })
})
.post('/api/v1/docs', { slug: slugTwo, body: docTwo.content, ...docTwo.data, lastUpdatedHash: hashTwo })
.basicAuth({ user: key })
.reply(201, {
metadata: { image: [], title: '', description: '' },
Expand All @@ -210,14 +209,14 @@ describe('rdme docs', () => {
url: '',
auth: 'required',
params: [],
apiSetting: '60ddf83e30681022753e27af',
apiSetting,
},
title: 'This is the document title',
updates: [],
type: 'endpoint',
slug: slugTwo,
body: 'Body',
category: '5ae122e10fdf4e39bb34db6f',
category,
});

return docs.run({ folder: './__tests__/__fixtures__/failure-docs', key, version }).then(message => {
Expand All @@ -230,20 +229,20 @@ describe('rdme docs', () => {
url: '',
auth: 'required',
params: [],
apiSetting: '60ddf83e30681022753e27af',
apiSetting,
},
title: 'This is the document title',
updates: [],
type: 'endpoint',
slug: slugTwo,
body: 'Body',
category: '5ae122e10fdf4e39bb34db6f',
category,
},
]);
getMock.done();
getMockTwo.done();
postMock.done();
postMockTwo.done();

getMocks.done();
postMocks.done();

console.log.mockRestore();
});
});
Expand Down Expand Up @@ -279,22 +278,14 @@ describe('rdme docs:edit', () => {
const body = 'abcdef';
const edits = 'ghijkl';

const getMock = nock(config.host, {
reqheaders: {
'x-readme-version': version,
},
})
const getMock = getNockWithVersionHeader(version)
.get(`/api/v1/docs/${slug}`)
.basicAuth({ user: key })
.reply(200, { category: '5ae9ece93a685f47efb9a97c', slug, body });
.reply(200, { category, slug, body });

const putMock = nock(config.host, {
reqheaders: {
'x-readme-version': version,
},
})
const putMock = getNockWithVersionHeader(version)
.put(`/api/v1/docs/${slug}`, {
category: '5ae9ece93a685f47efb9a97c',
category,
slug,
body: `${body}${edits}`,
})
Expand Down
Loading