paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 24 Packages Projects Releases Wiki Activity

Fix linting errors after #13392

Browse Source 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2022-08-30 13:43:57 +02:00
parent 3716ae33b2
commit aaab1e34da
151 changed files with 837 additions and 786 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/techdocs-backend/src/cache/TechDocsCache.test.ts
Vendored
+1 -1
View File
@@ -151,7 +151,7 @@ describe('TechDocsCache', () => {
await expect(
CacheUnderTest.invalidateMultiple(expectedPaths),
).rejects.toThrowError(CacheInvalidationError);
).rejects.toThrow(CacheInvalidationError);
expect(MockClient.delete).toHaveBeenCalledTimes(2);
});
plugins/techdocs-backend/src/service/CachedEntityLoader.test.ts
+10 -6
View File
@@ -58,7 +58,7 @@ describe('CachedEntityLoader', () => {
const result = await loader.load(entityName, token);
expect(result).toEqual(entity);
expect(cache.set).toBeCalledWith(
expect(cache.set).toHaveBeenCalledWith(
'catalog:component:default/test:test-token',
entity,
{ ttl: 5000 },
@@ -71,7 +71,7 @@ describe('CachedEntityLoader', () => {
const result = await loader.load(entityName, token);
expect(result).toEqual(entity);
expect(catalog.getEntityByRef).not.toBeCalled();
expect(catalog.getEntityByRef).not.toHaveBeenCalled();
});
it('does not cache missing entites', async () => {
@@ -81,7 +81,7 @@ describe('CachedEntityLoader', () => {
const result = await loader.load(entityName, token);
expect(result).toBeUndefined();
expect(cache.set).not.toBeCalled();
expect(cache.set).not.toHaveBeenCalled();
});
it('uses entity ref as cache key for anonymous users', async () => {
@@ -91,9 +91,13 @@ describe('CachedEntityLoader', () => {
const result = await loader.load(entityName, undefined);
expect(result).toEqual(entity);
expect(cache.set).toBeCalledWith('catalog:component:default/test', entity, {
ttl: 5000,
});
expect(cache.set).toHaveBeenCalledWith(
'catalog:component:default/test',
entity,
{
ttl: 5000,
},
);
});
it('calls the catalog if the cache read takes too long', async () => {
plugins/techdocs-backend/src/service/DocsSynchronizer.test.ts
+38 -24
View File
@@ -144,19 +144,21 @@ describe('DocsSynchronizer', () => {
generators,
});
expect(mockResponseHandler.log).toBeCalledTimes(3);
expect(mockResponseHandler.log).toBeCalledWith('Some log');
expect(mockResponseHandler.log).toBeCalledWith('Another log');
expect(mockResponseHandler.log).toBeCalledWith(
expect(mockResponseHandler.log).toHaveBeenCalledTimes(3);
expect(mockResponseHandler.log).toHaveBeenCalledWith('Some log');
expect(mockResponseHandler.log).toHaveBeenCalledWith('Another log');
expect(mockResponseHandler.log).toHaveBeenCalledWith(
expect.stringMatching(/info.*Some more log/),
);
expect(mockResponseHandler.finish).toBeCalledWith({ updated: true });
expect(mockResponseHandler.finish).toHaveBeenCalledWith({
updated: true,
});
expect(mockResponseHandler.error).toBeCalledTimes(0);
expect(mockResponseHandler.error).toHaveBeenCalledTimes(0);
expect(shouldCheckForUpdate).toBeCalledTimes(1);
expect(DocsBuilder.prototype.build).toBeCalledTimes(1);
expect(shouldCheckForUpdate).toHaveBeenCalledTimes(1);
expect(DocsBuilder.prototype.build).toHaveBeenCalledTimes(1);
});
it('should limit concurrent updates', async () => {
@@ -210,13 +212,15 @@ describe('DocsSynchronizer', () => {
generators,
});
expect(mockResponseHandler.finish).toBeCalledWith({ updated: false });
expect(mockResponseHandler.finish).toHaveBeenCalledWith({
updated: false,
});
expect(mockResponseHandler.log).toBeCalledTimes(0);
expect(mockResponseHandler.error).toBeCalledTimes(0);
expect(mockResponseHandler.log).toHaveBeenCalledTimes(0);
expect(mockResponseHandler.error).toHaveBeenCalledTimes(0);
expect(shouldCheckForUpdate).toBeCalledTimes(1);
expect(DocsBuilder.prototype.build).toBeCalledTimes(0);
expect(shouldCheckForUpdate).toHaveBeenCalledTimes(1);
expect(DocsBuilder.prototype.build).toHaveBeenCalledTimes(0);
});
it('should forward build errors', async () => {
@@ -242,15 +246,15 @@ describe('DocsSynchronizer', () => {
generators,
});
expect(mockResponseHandler.log).toBeCalledTimes(1);
expect(mockResponseHandler.log).toBeCalledWith(
expect(mockResponseHandler.log).toHaveBeenCalledTimes(1);
expect(mockResponseHandler.log).toHaveBeenCalledWith(
expect.stringMatching(
/error.*: Failed to build the docs page: Some random error/,
),
);
expect(mockResponseHandler.finish).toBeCalledTimes(0);
expect(mockResponseHandler.error).toBeCalledTimes(1);
expect(mockResponseHandler.error).toBeCalledWith(error);
expect(mockResponseHandler.finish).toHaveBeenCalledTimes(0);
expect(mockResponseHandler.error).toHaveBeenCalledTimes(1);
expect(mockResponseHandler.error).toHaveBeenCalledWith(error);
});
});
@@ -275,8 +279,10 @@ describe('DocsSynchronizer', () => {
entity,
});
expect(mockResponseHandler.finish).toBeCalledWith({ updated: false });
expect(shouldCheckForUpdate).toBeCalledTimes(1);
expect(mockResponseHandler.finish).toHaveBeenCalledWith({
updated: false,
});
expect(shouldCheckForUpdate).toHaveBeenCalledTimes(1);
});
it('should do nothing if source/cached metadata matches', async () => {
@@ -292,7 +298,9 @@ describe('DocsSynchronizer', () => {
entity,
});
expect(mockResponseHandler.finish).toBeCalledWith({ updated: false });
expect(mockResponseHandler.finish).toHaveBeenCalledWith({
updated: false,
});
});
it('should invalidate expected files when source/cached metadata differ', async () => {
@@ -309,7 +317,9 @@ describe('DocsSynchronizer', () => {
entity,
});
expect(mockResponseHandler.finish).toBeCalledWith({ updated: true });
expect(mockResponseHandler.finish).toHaveBeenCalledWith({
updated: true,
});
expect(cache.invalidateMultiple).toHaveBeenCalledWith([
'default/component/test/index.html',
]);
@@ -342,7 +352,9 @@ describe('DocsSynchronizer', () => {
entity,
});
expect(mockResponseHandler.finish).toBeCalledWith({ updated: true });
expect(mockResponseHandler.finish).toHaveBeenCalledWith({
updated: true,
});
expect(cache.invalidateMultiple).toHaveBeenCalledWith([
'default/Component/test/index.html',
]);
@@ -361,7 +373,9 @@ describe('DocsSynchronizer', () => {
entity,
});
expect(mockResponseHandler.finish).toBeCalledWith({ updated: false });
expect(mockResponseHandler.finish).toHaveBeenCalledWith({
updated: false,
});
});
it("adds the build log transport to the logger's list of transports", async () => {
plugins/techdocs-backend/src/service/router.test.ts
+20 -20
View File
@@ -231,7 +231,7 @@ data: "Invalid configuration. docsBuildStrategy.shouldBuild returned 'true', but
`,
);
expect(MockDocsSynchronizer.prototype.doSync).toBeCalledTimes(0);
expect(MockDocsSynchronizer.prototype.doSync).toHaveBeenCalledTimes(0);
});
it('should execute synchronization', async () => {
@@ -249,8 +249,8 @@ data: "Invalid configuration. docsBuildStrategy.shouldBuild returned 'true', but
.set('accept', 'text/event-stream')
.send();
expect(MockDocsSynchronizer.prototype.doSync).toBeCalledTimes(1);
expect(MockDocsSynchronizer.prototype.doSync).toBeCalledWith({
expect(MockDocsSynchronizer.prototype.doSync).toHaveBeenCalledTimes(1);
expect(MockDocsSynchronizer.prototype.doSync).toHaveBeenCalledWith({
responseHandler: {
log: expect.any(Function),
error: expect.any(Function),
@@ -313,7 +313,7 @@ data: {"updated":true}
.send();
expect(response.status).toBe(200);
expect(docsRouter).toBeCalled();
expect(docsRouter).toHaveBeenCalled();
});
it('should return assets from cache', async () => {
@@ -328,7 +328,7 @@ data: {"updated":true}
.send();
expect(response.status).toBe(200);
expect(MockTechDocsCache.get).toBeCalled();
expect(MockTechDocsCache.get).toHaveBeenCalled();
});
it('should check entity access when permissions are enabled', async () => {
@@ -347,7 +347,7 @@ data: {"updated":true}
.send();
expect(response.status).toBe(200);
expect(MockCachedEntityLoader.prototype.load).toBeCalled();
expect(MockCachedEntityLoader.prototype.load).toHaveBeenCalled();
});
it('should not return assets without corresponding entity access', async () => {
@@ -387,8 +387,8 @@ describe('createEventStream', () => {
it('should return correct event stream', async () => {
// called in beforeEach
expect(res.writeHead).toBeCalledTimes(1);
expect(res.writeHead).toBeCalledWith(200, {
expect(res.writeHead).toHaveBeenCalledTimes(1);
expect(res.writeHead).toHaveBeenCalledWith(200, {
'Cache-Control': 'no-cache',
Connection: 'keep-alive',
'Content-Type': 'text/event-stream',
@@ -400,45 +400,45 @@ describe('createEventStream', () => {
handlers.log('A Message');
expect(res.write).toBeCalledTimes(1);
expect(res.write).toBeCalledWith(`event: log
expect(res.write).toHaveBeenCalledTimes(1);
expect(res.write).toHaveBeenCalledWith(`event: log
data: "A Message"
`);
expect(res.flush).toBeCalledTimes(1);
expect(res.flush).toHaveBeenCalledTimes(1);
});
it('should write log', async () => {
handlers.log('A Message');
expect(res.write).toBeCalledTimes(1);
expect(res.write).toBeCalledWith(`event: log
expect(res.write).toHaveBeenCalledTimes(1);
expect(res.write).toHaveBeenCalledWith(`event: log
data: "A Message"
`);
expect(res.end).toBeCalledTimes(0);
expect(res.end).toHaveBeenCalledTimes(0);
});
it('should write error and end the connection', async () => {
handlers.error(new Error('Some Error'));
expect(res.write).toBeCalledTimes(1);
expect(res.write).toBeCalledWith(`event: error
expect(res.write).toHaveBeenCalledTimes(1);
expect(res.write).toHaveBeenCalledWith(`event: error
data: "Some Error"
`);
expect(res.end).toBeCalledTimes(1);
expect(res.end).toHaveBeenCalledTimes(1);
});
it('should finish and end the connection', async () => {
handlers.finish({ updated: true });
expect(res.write).toBeCalledTimes(1);
expect(res.write).toBeCalledWith(`event: finish
expect(res.write).toHaveBeenCalledTimes(1);
expect(res.write).toHaveBeenCalledWith(`event: finish
data: {"updated":true}
`);
expect(res.end).toBeCalledTimes(1);
expect(res.end).toHaveBeenCalledTimes(1);
});
});