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.

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

Fix webservice wrong URL #62

Merged
merged 1 commit into from
Oct 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,13 @@ services:
backend:
build:
context: .
dockerfile: Dockerfile_Backend
dockerfile: PlaygroundMonoDockerfile
ports:
- '8080:8080'
depends_on:
- dicedb
environment:
- DICE_ADDR=dicedb:7379
- DICEDB_ADDR=dicedb:7379
```

2. Run the following command to start the backend server and DiceDB:
Expand Down Expand Up @@ -123,15 +123,17 @@ To generate a static production build of your Next.js application, follow these
Ensure that you have the following line in your `next.config.mjs` file:

```javascript
output: 'export'
output: 'export';
```

2. **Build the Project:**

Run the following command in your terminal:

```bash
npm run build
```

3. **Testing static build locally:**
```bash
npx serve@latest out
Expand Down Expand Up @@ -188,6 +190,6 @@ Contributors can join the [Discord Server](https://discord.gg/6r8uXWtXh7) for qu

## Contributors

<a href = "https://github.com/dicedb/dice/graphs/contributors">
<img src = "https://contrib.rocks/image?repo=dicedb/dice"/>
<a href = "https://github.com/dicedb/playground-web/graphs/contributors">
<img src = "https://contrib.rocks/image?repo=dicedb/playground-web"/>
</a>
148 changes: 148 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
"postcss": "^8",
"prettier": "^3.3.3",
"tailwindcss": "^3.4.1",
"ts-jest": "^29.2.5",
"ts-node": "^10.9.2",
"typescript": "^5"
},
Expand Down
93 changes: 93 additions & 0 deletions src/lib/__tests__/api.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
import { executeShellCommandOnServer } from '../api';
import { WebService } from '@/services/webServices';

// Mock WebService
jest.mock('@/services/webServices', () => ({
WebService: {
post: jest.fn(),
},
}));

describe('executeShellCommandOnServer', () => {
const mockCmd = 'testCommand';
const mockCmdOptions = { option1: 'value1' };
const mockCmdExecURL = `/shell/exec/${mockCmd}`;
let consoleErrorSpy: jest.SpyInstance;

beforeEach(() => {
consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
});

afterEach(() => {
consoleErrorSpy.mockRestore();
jest.clearAllMocks();
});

it('should return data when WebService.post is successful', async () => {
const mockResponse = { data: 'Success Response' };
(WebService.post as jest.Mock).mockResolvedValueOnce(mockResponse);

const result = await executeShellCommandOnServer(mockCmd, mockCmdOptions);

expect(WebService.post).toHaveBeenCalledWith(
mockCmdExecURL,
mockCmdOptions,
);
expect(result).toEqual('Success Response');
});

it('should return error message when response structure is unexpected', async () => {
const mockResponse = {}; // Simulate unexpected response structure
(WebService.post as jest.Mock).mockResolvedValueOnce(mockResponse);

const result = await executeShellCommandOnServer(mockCmd, mockCmdOptions);

expect(result).toBe('Error: Error: Unexpected response structure');
expect(WebService.post).toHaveBeenCalledWith(
mockCmdExecURL,
mockCmdOptions,
);
});

it('should return error message when WebService.post throws an error', async () => {
const mockError = new Error('Network Error');

(WebService.post as jest.Mock).mockRejectedValueOnce(mockError);
const result = await executeShellCommandOnServer(mockCmd, mockCmdOptions);
expect(WebService.post).toHaveBeenCalledWith(
mockCmdExecURL,
mockCmdOptions,
);
expect(result).toBe(`Error: ${mockError}`);
consoleErrorSpy.mockRestore();
});

it('should log error to the console when WebService.post throws an error', async () => {
const mockError = new Error('Request Failed');
const consoleSpy = jest
.spyOn(console, 'error')
.mockImplementation(() => {});
(WebService.post as jest.Mock).mockRejectedValueOnce(mockError);

await executeShellCommandOnServer(mockCmd, mockCmdOptions);

expect(consoleSpy).toHaveBeenCalledWith(
'Error executing command:',
mockError,
);
consoleSpy.mockRestore();
});

it('should always include the cmd parameter in the URL', async () => {
const mockResponse = { data: 'Some Response' };
(WebService.post as jest.Mock).mockResolvedValueOnce(mockResponse);

const result = await executeShellCommandOnServer(mockCmd, mockCmdOptions);

expect(WebService.post).toHaveBeenCalledWith(
expect.stringContaining(`/shell/exec/${mockCmd}`),
mockCmdOptions,
);
expect(result).toEqual('Some Response');
});
});
4 changes: 3 additions & 1 deletion src/lib/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ export const executeShellCommandOnServer = async (
cmd: string,
cmdOptions: object,
) => {
const cmdExecURL = `/shell/exec/${cmd}`;

try {
const response = await WebService.post(`/shell/exec`, cmdOptions);
const response = await WebService.post(cmdExecURL, cmdOptions);
if (response?.data) {
return response.data;
} else {
Expand Down
8 changes: 7 additions & 1 deletion src/services/webServices.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ let PLAYGROUND_MONO_URL = process.env.NEXT_PUBLIC_PLAYGROUND_MONO_URL;

if (!PLAYGROUND_MONO_URL) {
console.warn(
'Warning: NEXT_PUBLIC_BACKEND_URL is not defined. Defaulting to http://localhost:3000',
'Warning: NEXT_PUBLIC_PLAYGROUND_MONO_URL is not defined. Defaulting to http://localhost:8080',
);
PLAYGROUND_MONO_URL = 'http://localhost:8080';
}
Expand Down Expand Up @@ -41,10 +41,16 @@ export const WebService = {

try {
const response = await fetch(`${PLAYGROUND_MONO_URL}${url}`, options);
if (!response) {
throw new Error('No response received from the server.');
}

if (!response.ok) {
throw new Error(`HTTP error! Status: ${response.status}`);
}

const result = await response.json();

return result;
} catch (error) {
if (error instanceof Error)
Expand Down
Loading