fix: check instance name is valid (#42)

* fix: check instance name is valid

* fix: test should not depend on env variable

* fix: test that valid instance names can be used

packages/core/src/core.test.ts

@@ -0,0 +1,45 @@
+import { Context } from './context';
+import { createInstance, isValidInstanceName } from './core';
+import { InvalidName } from './errors';
+import { createFetch } from './fetch';
+
+jest.mock('./fetch');
+
+describe('Core functionalities', () => {
+  afterAll(() => {
+    jest.clearAllMocks();
+  });
+
+  test('validate instance name', () => {
+    expect(isValidInstanceName('myinstance')).toEqual(true);
+    expect(isValidInstanceName('my-instance')).toEqual(false);
+  });
+
+  test('an instance with an invalid name cannot be created', async () => {
+    await expect(
+      createInstance(
+        new Context({ personalAccessToken: 'dummy' }),
+        'eyevinn-test-adserver',
+        'my-token',
+        {
+          name: 'my-instance'
+        }
+      )
+    ).rejects.toThrow(new InvalidName('my-instance'));
+    expect(createFetch).not.toHaveBeenCalled();
+  });
+
+  test('an instance with an valid name can be created', async () => {
+    await expect(
+      createInstance(
+        new Context({ personalAccessToken: 'dummy' }),
+        'eyevinn-test-adserver',
+        'my-token',
+        {
+          name: 'myinstance'
+        }
+      )
+    ).rejects.not.toThrow(new InvalidName('myinstance'));
+    expect(createFetch).toHaveBeenCalled();
+  });
+});

packages/core/src/core.ts

@@ -1,5 +1,5 @@
 import { Context, Service } from './context';
-import { UnauthorizedError } from './errors';
+import { InvalidName, UnauthorizedError } from './errors';
 import { FetchError, createFetch } from './fetch';
 import { Log } from './log';
 
@@ -21,6 +21,10 @@ export async function getService(context: Context, serviceId: string) {
   return service;
 }
 
+export const isValidInstanceName = (name: string) => {
+  return /^[a-z0-9]+$/.test(name);
+};
+
 export type Port = {
   externalIp: string;
   externalPort: number;
@@ -57,6 +61,9 @@ export async function createInstance(
   token: string,
   body: any
 ): Promise<any> {
+  if (!isValidInstanceName(body.name)) {
+    throw new InvalidName(body.name);
+  }
   const service = await getService(context, serviceId);
   const instanceUrl = new URL(service.apiUrl);
 

packages/core/src/errors.ts

@@ -9,3 +9,9 @@ export class UnauthorizedError extends Error {
     super('Unauthorized');
   }
 }
+
+export class InvalidName extends Error {
+  constructor(name: string) {
+    super(`Invalid name: ${name}. Only alphanumeric characters are allowed.`);
+  }
+}