chore: Restructure packages (#61)

* restructure * lint * test restructure+workflows * lint * add temporary workaround * remove log * change tsconfig setup * mock env in global setup * fix tsconfig.test * fix test * add core to canary release * add ignored packages to config.json * Update test-util/mock-http.ts Co-authored-by: Marika Marszalkowski <[email protected]> * Update packages/core/src/context.test.ts Co-authored-by: Marika Marszalkowski <[email protected]> * review * fix: Changes from lint * update docs * docs * fix: Changes from lint --------- Co-authored-by: Tom Frenken <[email protected]> Co-authored-by: Marika Marszalkowski <[email protected]> Co-authored-by: cloud-sdk-js <[email protected]>
SAP · Aug 13, 2024 · 8bde567 · 8bde567
1 parent 5bf34b5
commit 8bde567
Show file tree

Hide file tree

Showing 53 changed files with 453 additions and 386 deletions.
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -7,5 +7,5 @@
   "access": "public",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",
-  "ignore": []
+  "ignore": ["@sap-ai-sdk/sample-code", "@sap-ai-sdk/e2e-tests", "@sap-ai-sdk/type-tests"]
 }
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -25,7 +25,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: 'pnpm'
       - run: pnpm i --frozen-lockfile
-      - run: pnpm test
+      - run: pnpm test:unit
       - run: pnpm test:type
 
   checks:

diff --git a/.github/workflows/e2e-test.yaml b/.github/workflows/e2e-test.yaml
@@ -52,9 +52,7 @@ jobs:
           done
           wget -qO- -S --content-on-error localhost:8080
       - name: "Execute E2E Tests"
-        working-directory: ./tests/e2e-tests
-        run: |
-          pnpm run e2e-test
+        run: pnpm test:e2e
       - name: "Slack Notification"
         if: failure()
         uses: slackapi/[email protected]

diff --git a/.github/workflows/publish-canary.yml b/.github/workflows/publish-canary.yml
@@ -35,6 +35,7 @@ jobs:
           cat <<EOT >> .changeset/canary-release-changeset.md
           ---
           '@sap-ai-sdk/ai-core': patch
+          '@sap-ai-sdk/core': patch
           '@sap-ai-sdk/gen-ai-hub': patch
           ---
 

diff --git a/eslint.config.js b/eslint.config.js
@@ -2,6 +2,11 @@ import flatConfig from '@sap-cloud-sdk/eslint-config/flat-config.js';
 
 export default [
   ...flatConfig,
+  {
+    // Estlint flat config is not supported by eslint-plugin-import.
+    // https://github.com/import-js/eslint-plugin-import/issues/2556
+    rules: { 'import/namespace': 'off'}
+  },
   {
     ignores: ['**/dist/**/*', '**/coverage/**/*', 'packages/ai-core/src/client/**/*'],
   },

diff --git a/global-test-setup.ts b/global-test-setup.ts
@@ -0,0 +1,14 @@
+/**
+ * This file is used to mock the environment variables that are required for the tests.
+ */
+export default async function mockAiCoreEnvVariable(): Promise<void> {
+    const aiCoreServiceCredentials =  {
+        clientid: 'clientid',
+        clientsecret: 'clientsecret',
+        url: 'https://example.authentication.eu12.hana.ondemand.com',
+        serviceurls: {
+          AI_API_URL: 'https://api.ai.ml.hana.ondemand.com'
+        }
+      };
+    process.env['aicore'] = JSON.stringify(aiCoreServiceCredentials);
+}
diff --git a/global-test-teardown.ts b/global-test-teardown.ts
@@ -0,0 +1,6 @@
+/**
+ * This file is used to run code after all tests have been run.
+ */
+export default async function tearDown(): Promise<void> {
+    delete process.env.aicore;
+}
diff --git a/jest.config.mjs b/jest.config.mjs
@@ -54,10 +54,10 @@ const config = {
   // forceCoverageMatch: [],
 
   // A path to a module which exports an async function that is triggered once before all test suites
-  // globalSetup: undefined,
+   globalSetup: '../../global-test-setup.ts',
 
   // A path to a module which exports an async function that is triggered once after all test suites
-  // globalTeardown: undefined,
+   globalTeardown: '../../global-test-teardown.ts',
 
   // A set of global variables that need to be available in all test environments
   // globals: {},
@@ -174,6 +174,7 @@ const config = {
       'ts-jest',
       {
         useESM: true,
+        tsconfig: '../../tsconfig.test.json',
       },
     ],
   },

diff --git a/package.json b/package.json
@@ -7,24 +7,25 @@
   "repository": "github:SAP/ai-sdk-js",
   "private": true,
   "type": "module",
-  "types": "tests/type-tests",
-  "tsd": {
-    "directory": "tests/type-tests"
-  },
   "scripts": {
     "postinstall": "pnpm compile",
     "compile": "pnpm -r -w=false run compile",
-    "test": "NODE_OPTIONS=--experimental-vm-modules pnpm -r run test",
-    "test:type": "tsd",
+    "test:unit": "pnpm -r -F=./packages/** test",
+    "test:type": "pnpm -F=@sap-ai-sdk/type-tests test",
+    "test:e2e": "pnpm -F=@sap-ai-sdk/e2e-tests test",
     "lint": "pnpm -r run lint",
     "lint:fix": "pnpm -r run lint:fix",
-    "generate": "pnpm -r run generate"
+    "generate": "pnpm -r run generate",
+    "ai-core": "pnpm -F=@sap-ai-sdk/ai-core",
+    "gen-ai-hub": "pnpm -F=@sap-ai-sdk/gen-ai-hub",
+    "core": "pnpm -F=@sap-ai-sdk/core"
   },
   "devDependencies": {
     "@changesets/cli": "^2.27.7",
     "@sap-cloud-sdk/eslint-config": "^3.18.0",
     "@sap-cloud-sdk/connectivity": "^3.18.0",
     "@sap-cloud-sdk/http-client": "^3.18.0",
+    "@sap-ai-sdk/core": "workspace:^",
     "@types/jest": "^29.5.12",
     "@types/node": "^20.14.15",
     "@jest/globals": "^29.5.12",
@@ -34,7 +35,8 @@
     "prettier": "^3.3.3",
     "ts-jest": "^29.2.4",
     "ts-node": "^10.9.2",
-    "tsd": "^0.31.0",
-    "typescript": "^5.5.4"
+    "typescript": "^5.5.4",
+    "jsonwebtoken": "^9.0.2",
+    "@types/jsonwebtoken": "^9.0.2"
   }
 }
diff --git a/packages/ai-core/jest.config.mjs b/packages/ai-core/jest.config.mjs
@@ -1,7 +1,5 @@
 import config from '../../jest.config.mjs';
-const aiCoreConfig = {
+export default {
   ...config,
   displayName: 'ai-core',
 };
-
-export default aiCoreConfig;
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -0,0 +1,18 @@
+# @sap-ai-sdk/core
+
+This package contains core utility functions that we reuse in the SDK to set the context and execute HTTP requests.
+They are primarily designed for internal usage.
+
+### Installation
+
+```
+$ npm install @sap-ai-sdk/core
+```
+
+### Usage
+
+The core package is not intended for direct usage.
+
+## License
+
+The SAP AI SDK is released under the [Apache License Version 2.0.](http://www.apache.org/licenses/)
diff --git a/packages/core/jest.config.mjs b/packages/core/jest.config.mjs
@@ -0,0 +1,5 @@
+import config from '../../jest.config.mjs';
+export default {
+  ...config,
+  displayName: 'core',
+};
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -0,0 +1,33 @@
+{
+  "name": "@sap-ai-sdk/core",
+  "version": "0.0.0",
+  "description": "",
+  "license": "Apache-2.0",
+  "keywords": [
+    "sap-ai-sdk",
+    "ai-core"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.js.map",
+    "dist/**/*.d.ts",
+    "dist/**/*.d.ts.map"
+  ],
+  "scripts": {
+    "compile": "tsc",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest",
+    "lint": "eslint . && prettier . --config ../../.prettierrc --ignore-path ../../.prettierignore -c",
+    "lint:fix": "eslint . --fix && prettier . --config ../../.prettierrc --ignore-path ../../.prettierignore -w --log-level error"
+  },
+  "dependencies": {
+    "@sap-cloud-sdk/http-client": "^3.18.0",
+    "@sap-cloud-sdk/connectivity": "^3.18.0",
+    "@sap-cloud-sdk/util": "^3.18.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.5.4"
+  }
+}
diff --git a/packages/core/src/context.test.ts b/packages/core/src/context.test.ts
@@ -0,0 +1,22 @@
+import nock from 'nock';
+import { mockClientCredentialsGrantCall } from '../../../test-util/mock-http.js';
+import { getAiCoreDestination } from './context.js';
+
+describe('context', () => {
+  afterEach(() => {
+    nock.cleanAll();
+  });
+
+  it('should throw if client credentials are not fetched', async () => {
+    mockClientCredentialsGrantCall(
+      {
+        error: 'unauthorized',
+        error_description: 'Bad credentials'
+      },
+      401
+    );
+    await expect(getAiCoreDestination()).rejects.toThrow(
+      /Could not fetch client credentials token for service of type "aicore"/
+    );
+  });
+});
diff --git a/packages/gen-ai-hub/src/core/context.ts → packages/core/src/context.ts b/packages/gen-ai-hub/src/core/context.ts → packages/core/src/context.ts
@@ -2,12 +2,13 @@ import { createLogger } from '@sap-cloud-sdk/util';
 import {
   Destination,
   Service,
+  ServiceCredentials,
   getServiceBinding,
   transformServiceBindingToDestination
 } from '@sap-cloud-sdk/connectivity';
 
 const logger = createLogger({
-  package: 'gen-ai-hub',
+  package: 'core',
   messageContext: 'context'
 });
 
@@ -31,7 +32,8 @@ export async function getAiCoreDestination(): Promise<Destination> {
   const aiCoreDestination = await transformServiceBindingToDestination(
     aiCoreServiceBinding,
     {
-      useCache: true
+      useCache: true,
+      jwt: { zid: 'dummy-tenant' }
     }
   );
   return aiCoreDestination;
@@ -52,7 +54,9 @@ function getAiCoreServiceKeyFromEnv(): Service | undefined {
   }
 }
 
-function parseServiceKeyFromEnv(aiCoreEnv: string | undefined) {
+function parseServiceKeyFromEnv(
+  aiCoreEnv: string | undefined
+): ServiceCredentials | undefined {
   if (aiCoreEnv) {
     try {
       return JSON.parse(aiCoreEnv);

diff --git a/...s/gen-ai-hub/src/core/http-client.test.ts → packages/core/src/http-client.test.ts b/...s/gen-ai-hub/src/core/http-client.test.ts → packages/core/src/http-client.test.ts
@@ -1,26 +1,18 @@
-import { jest } from '@jest/globals';
-import { HttpDestination } from '@sap-cloud-sdk/connectivity';
-import { mockGetAiCoreDestination } from '../test-util/mock-context.js';
-import { mockInference } from '../test-util/mock-http.js';
-
-jest.unstable_mockModule('./context.js', () => ({
-  getAiCoreDestination: jest.fn(() =>
-    Promise.resolve(mockGetAiCoreDestination())
-  )
-}));
-const { executeRequest } = await import('./http-client.js');
+import nock from 'nock';
+import {
+  mockClientCredentialsGrantCall,
+  mockInference
+} from '../../../test-util/mock-http.js';
+import { dummyToken } from '../../../test-util/mock-jwt.js';
+import { executeRequest } from './http-client.js';
 
 describe('http-client', () => {
-  let destination: HttpDestination;
-
   beforeAll(() => {
-    destination = mockGetAiCoreDestination();
+    mockClientCredentialsGrantCall({ access_token: dummyToken }, 200);
   });
-
-  afterAll(() => {
-    jest.restoreAllMocks();
+  afterEach(() => {
+    nock.cleanAll();
   });
-
   it('should execute a request to the AI Core service', async () => {
     const mockPrompt = { prompt: 'some test prompt' };
     const mockPromptResponse = { completion: 'some test completion' };
@@ -35,8 +27,7 @@ describe('http-client', () => {
       {
         data: mockPromptResponse,
         status: 200
-      },
-      destination
+      }
     );
     const res = await executeRequest(
       { url: '/mock-endpoint', apiVersion: 'mock-api-version' },

diff --git a/packages/gen-ai-hub/src/core/http-client.ts → packages/core/src/http-client.ts b/packages/gen-ai-hub/src/core/http-client.ts → packages/core/src/http-client.ts
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -0,0 +1,7 @@
+export {
+  executeRequest,
+  BaseLlmParametersWithDeploymentId,
+  BaseLlmParameters,
+  CustomRequestConfig
+} from './http-client.js';
+export { getAiCoreDestination } from './context.js';
diff --git a/packages/core/tsconfig.json b/packages/core/tsconfig.json
@@ -0,0 +1,11 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "tsBuildInfoFile": "./dist/.tsbuildinfo",
+    "composite": true
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["dist/**/*", "**/*.test.ts", "node_modules/**/*"]
+}
diff --git a/packages/gen-ai-hub/package.json b/packages/gen-ai-hub/package.json
@@ -27,6 +27,7 @@
     "generate:orchestration": "openapi-generator --overwrite --generateESM -i ./src/orchestration/spec/api.yaml -o ./src/orchestration/client && pnpm lint:fix"
   },
   "dependencies": {
+    "@sap-ai-sdk/core": "workspace:^",
     "@sap-cloud-sdk/http-client": "^3.18.0",
     "@sap-cloud-sdk/connectivity": "^3.18.0",
     "@sap-cloud-sdk/util": "^3.18.0",

diff --git a/packages/gen-ai-hub/src/client/interface.ts b/packages/gen-ai-hub/src/client/interface.ts
@@ -1,4 +1,4 @@
-import { BaseLlmParameters, CustomRequestConfig } from '../core/http-client.js';
+import { BaseLlmParameters, CustomRequestConfig } from '@sap-ai-sdk/core';
 import { BaseLlmOutput } from './types.js';
 
 /**