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

Jump to bottom

Develop 6.2.x #17648

Merged
merged 13 commits into from
Jul 17, 2023
Merged

Develop 6.2.x #17648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
88d56e6
fix: add jira num for e2e tests (#17552)
i333055 Jun 21, 2023
23e537e
test: Fix the instability issue in ASM E2E tests, as well as the fail…
luoyifeng11 Jun 22, 2023
4464f61
feat: CXSPA-3742 - SSR logging - addresing minor comments (#17538)
pawelfras Jun 22, 2023
05cc70b
feat: update text as UX suggested #17522 for 6.2 (#17565)
scarai-sap Jun 23, 2023
eebc403
test: fix ASM E2E test instability for 6.2 (#17569)
luoyifeng11 Jun 23, 2023
cfa7efd
fix: Need to adapt to the width of mobile webpage on CustomerList (#1…
i53577 Jun 27, 2023
f3d508b
fix/CXSPA-3848: cherry-pick buf fixes from branch 6.1.x to branch 6.2…
niehuayang Jun 27, 2023
47346c7
fix: configurator restart must remove UI state as well (#17581)
ChristophHi Jun 27, 2023
ed1e1a7
chore: CXSPA-3794 - SSR contextual logging extensibility (#17578)
pawelfras Jun 28, 2023
6d5b7ba
fix: 'this' is undefined in ProductEffects.productLoadEffect (#17594)
Platonn Jun 30, 2023
c8de006
CDC-B2B- Bug (#17628)
anjana-bl Jul 12, 2023
39b18c3
Release 6.2.0
RadhepS Jul 13, 2023
afa21b1
Release 6.2.1 (#17640)
kimhw0630 Jul 14, 2023
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
10 changes: 5 additions & 5 deletions core-libs/setup/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@spartacus/setup",
"version": "6.2.0-1",
"version": "6.2.1",
"description": "Includes features that makes Spartacus and it's setup easier and streamlined.",
"keywords": [
"spartacus",
Expand All @@ -20,10 +20,10 @@
},
"peerDependencies": {
"@angular/core": "^15.2.4",
"@spartacus/cart": "6.2.0-1",
"@spartacus/core": "6.2.0-1",
"@spartacus/order": "6.2.0-1",
"@spartacus/user": "6.2.0-1"
"@spartacus/cart": "6.2.1",
"@spartacus/core": "6.2.1",
"@spartacus/order": "6.2.1",
"@spartacus/user": "6.2.1"
},
"optionalDependencies": {
"@angular/platform-server": "^15.2.4",
Expand Down
4 changes: 2 additions & 2 deletions core-libs/setup/ssr/logger/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
* SPDX-License-Identifier: Apache-2.0
*/

export * from './loggers';
export * from './services';
export * from './loggers/index';
export * from './services/index';
275 changes: 263 additions & 12 deletions core-libs/setup/ssr/logger/loggers/default-express-server-logger.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
import * as angularCore from '@angular/core';
import { Request } from 'express';
import { DefaultExpressServerLogger } from './default-express-server-logger';
import { ExpressServerLoggerContext } from './express-server-logger';

const request = {
originalUrl: 'test',
res: {
locals: {
cx: {
request: { uuid: 'test', timeReceived: new Date('2023-05-26') },
},
},
},
} as unknown as Request;

describe('DefaultExpressServerLogger', () => {
let logger: DefaultExpressServerLogger;
Expand All @@ -21,7 +32,7 @@ describe('DefaultExpressServerLogger', () => {
logger.log('test', { request: {} as Request });

expect(logSpy).toHaveBeenCalledWith(
logger['createLogMessage']('test', { request: {} as Request })
logger['stringifyWithContext']('test', { request: {} as Request })
);
});

Expand All @@ -31,7 +42,7 @@ describe('DefaultExpressServerLogger', () => {
logger.warn('test', { request: {} as Request });

expect(warnSpy).toHaveBeenCalledWith(
logger['createLogMessage']('test', { request: {} as Request })
logger['stringifyWithContext']('test', { request: {} as Request })
);
});

Expand All @@ -43,7 +54,7 @@ describe('DefaultExpressServerLogger', () => {
logger.error('test', { request: {} as Request });

expect(errorSpy).toHaveBeenCalledWith(
logger['createLogMessage']('test', { request: {} as Request })
logger['stringifyWithContext']('test', { request: {} as Request })
);
});

Expand All @@ -53,7 +64,7 @@ describe('DefaultExpressServerLogger', () => {
logger.info('test', { request: {} as Request });

expect(infoSpy).toHaveBeenCalledWith(
logger['createLogMessage']('test', { request: {} as Request })
logger['stringifyWithContext']('test', { request: {} as Request })
);
});

Expand All @@ -65,30 +76,270 @@ describe('DefaultExpressServerLogger', () => {
logger.debug('test', { request: {} as Request });

expect(debugSpy).toHaveBeenCalledWith(
logger['createLogMessage']('test', { request: {} as Request })
logger['stringifyWithContext']('test', { request: {} as Request })
);
});

describe('is not dev mode', () => {
beforeEach(() => {
jest.spyOn(angularCore, 'isDevMode').mockReturnValue(false);
});

it('should log proper shape of the JSON', () => {
const debugSpy = jest
.spyOn(console, 'log')
.mockImplementation(() => {});

logger.log('test', { request });

expect(debugSpy.mock.lastCall).toMatchInlineSnapshot(`
[
"{"message":"test","context":{"timestamp":"2023-05-26T00:00:00.000Z","request":{"url":"test","uuid":"test","timeReceived":"2023-05-26T00:00:00.000Z"}}}",
]
`);
});

it('should warn proper shape of the JSON', () => {
const debugSpy = jest
.spyOn(console, 'warn')
.mockImplementation(() => {});

logger.warn('test', { request });

expect(debugSpy.mock.lastCall).toMatchInlineSnapshot(`
[
"{"message":"test","context":{"timestamp":"2023-05-26T00:00:00.000Z","request":{"url":"test","uuid":"test","timeReceived":"2023-05-26T00:00:00.000Z"}}}",
]
`);
});

it('should error proper shape of the JSON', () => {
const debugSpy = jest
.spyOn(console, 'error')
.mockImplementation(() => {});

logger.error('test', { request });

expect(debugSpy.mock.lastCall).toMatchInlineSnapshot(`
[
"{"message":"test","context":{"timestamp":"2023-05-26T00:00:00.000Z","request":{"url":"test","uuid":"test","timeReceived":"2023-05-26T00:00:00.000Z"}}}",
]
`);
});

it('should info proper shape of the JSON', () => {
const request = {
originalUrl: 'test',
res: {
locals: {
cx: {
request: { uuid: 'test', timeReceived: new Date() },
},
},
},
} as unknown as Request;

const debugSpy = jest
.spyOn(console, 'info')
.mockImplementation(() => {});

logger.info('test', { request });

expect(debugSpy.mock.lastCall).toMatchInlineSnapshot(`
[
"{"message":"test","context":{"timestamp":"2023-05-26T00:00:00.000Z","request":{"url":"test","uuid":"test","timeReceived":"2023-05-26T00:00:00.000Z"}}}",
]
`);
});

it('should debug proper shape of the JSON', () => {
const debugSpy = jest
.spyOn(console, 'debug')
.mockImplementation(() => {});

logger.debug('test', { request });

expect(debugSpy.mock.lastCall).toMatchInlineSnapshot(`
[
"{"message":"test","context":{"timestamp":"2023-05-26T00:00:00.000Z","request":{"url":"test","uuid":"test","timeReceived":"2023-05-26T00:00:00.000Z"}}}",
]
`);
});
});

describe('is dev mode', () => {
beforeEach(() => {
jest.spyOn(angularCore, 'isDevMode').mockReturnValue(true);
});

it('should log proper shape of the JSON', () => {
const debugSpy = jest
.spyOn(console, 'log')
.mockImplementation(() => {});

logger.log('test', { request });

expect(debugSpy.mock.lastCall).toMatchInlineSnapshot(`
[
"{
"message": "test",
"context": {
"timestamp": "2023-05-26T00:00:00.000Z",
"request": {
"url": "test",
"uuid": "test",
"timeReceived": "2023-05-26T00:00:00.000Z"
}
}
}",
]
`);
});

it('should warn proper shape of the JSON', () => {
const debugSpy = jest
.spyOn(console, 'warn')
.mockImplementation(() => {});

logger.warn('test', { request });

expect(debugSpy.mock.lastCall).toMatchInlineSnapshot(`
[
"{
"message": "test",
"context": {
"timestamp": "2023-05-26T00:00:00.000Z",
"request": {
"url": "test",
"uuid": "test",
"timeReceived": "2023-05-26T00:00:00.000Z"
}
}
}",
]
`);
});

it('should error proper shape of the JSON', () => {
const debugSpy = jest
.spyOn(console, 'error')
.mockImplementation(() => {});

logger.error('test', { request });

expect(debugSpy.mock.lastCall).toMatchInlineSnapshot(`
[
"{
"message": "test",
"context": {
"timestamp": "2023-05-26T00:00:00.000Z",
"request": {
"url": "test",
"uuid": "test",
"timeReceived": "2023-05-26T00:00:00.000Z"
}
}
}",
]
`);
});

it('should info proper shape of the JSON', () => {
const debugSpy = jest
.spyOn(console, 'info')
.mockImplementation(() => {});

logger.info('test', { request });

expect(debugSpy.mock.lastCall).toMatchInlineSnapshot(`
[
"{
"message": "test",
"context": {
"timestamp": "2023-05-26T00:00:00.000Z",
"request": {
"url": "test",
"uuid": "test",
"timeReceived": "2023-05-26T00:00:00.000Z"
}
}
}",
]
`);
});

it('should debug proper shape of the JSON', () => {
const debugSpy = jest
.spyOn(console, 'debug')
.mockImplementation(() => {});

logger.debug('test', { request });

expect(debugSpy.mock.lastCall).toMatchInlineSnapshot(`
[
"{
"message": "test",
"context": {
"timestamp": "2023-05-26T00:00:00.000Z",
"request": {
"url": "test",
"uuid": "test",
"timeReceived": "2023-05-26T00:00:00.000Z"
}
}
}",
]
`);
});
});
});

describe('create log message', () => {
it('should return message without request', () => {
const logMessage = logger['createLogMessage'](
'test',
{} as ExpressServerLoggerContext
);
const logMessage = logger['stringifyWithContext']('test', {});

expect(logMessage).not.toContain('request');
});

it('should return message with request', () => {
const logMessage = logger['createLogMessage']('test', {
const logMessage = logger['stringifyWithContext']('test', {
request: {} as Request,
});

expect(logMessage).toContain('request');
});
});

describe('map context', () => {
it('should return context without request', () => {
const context = logger['mapContext']({
options: {},
});

expect(context).toMatchInlineSnapshot(`
{
"options": {},
"timestamp": "2023-05-26T00:00:00.000Z",
}
`);
});

it('should return context with request', () => {
const context = logger['mapContext']({ request });

expect(context).toMatchInlineSnapshot(`
{
"request": {
"timeReceived": 2023-05-26T00:00:00.000Z,
"url": "test",
"uuid": "test",
},
"timestamp": "2023-05-26T00:00:00.000Z",
}
`);
});
});

describe('map request', () => {
it('should return mapped request', () => {
const request = {
Expand All @@ -106,7 +357,7 @@ describe('DefaultExpressServerLogger', () => {

expect(mappedRequest).toEqual({
url: 'test',
...request.res.locals.cx.request,
...request.res?.locals.cx.request,
});
});
});
Expand Down
Loading
Loading