Integration tests for common runtimes (#186)

This commit adds some basic integration tests and a new ci workflow
for our three common runtimes, nodejs with commonjs and esm as well
as TypeScript. The aim here is to ensure that the interface is
consistent even if we refactor/restructure the package.

The change does require a `REPLICATE_API_TOKEN` to be available in
the CI environment.

Co-authored-by: Zeke Sikelianos <zeke@sikelianos.com>

Author: aron

.github/workflows/ci.yml

@@ -26,3 +26,26 @@ jobs:
       - run: npm run test
       - run: npm run check
       - run: npm run lint
+
+  integration:
+    needs: test
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x]
+        suite: [commonjs, esm, typescript]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/previous-releases
+
+    env:
+      REPLICATE_API_TOKEN: ${{ secrets.REPLICATE_API_TOKEN }}
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+      - run: npm --prefix integration/${{ matrix.suite }} ci --omit=dev
+      - run: npm --prefix integration/${{ matrix.suite }} test

integration/commonjs/index.js

@@ -0,0 +1,16 @@
+const Replicate = require("replicate");
+
+const replicate = new Replicate({
+  auth: process.env.REPLICATE_API_TOKEN,
+});
+
+module.exports = async function main() {
+  return await replicate.run(
+    "replicate/hello-world:5c7d5dc6dd8bf75c1acaa8565735e7986bc5b66206b55cca93cb72c9bf15ccaa",
+    {
+      input: {
+        text: "Claire CommonJS"
+      }
+    }
+  );
+};

integration/commonjs/index.test.js

@@ -0,0 +1,8 @@
+const { test } = require('node:test');
+const assert = require('node:assert');
+const main = require('./index');
+
+test('main', async () => {
+  const output = await main();
+  assert.equal(output, "hello Claire CommonJS");
+});

integration/commonjs/package-lock.json

@@ -0,0 +1,13 @@
+{
+  "name": "replicate-app-commonjs",
+  "version": "0.0.0",
+  "private": true,
+  "description": "CommonJS integration tests",
+  "main": "index.js",
+  "scripts": {
+    "test": "node --test ./index.test.js"
+  },
+  "dependencies": {
+    "replicate": "file:../../"
+  }
+}

integration/commonjs/package.json

@@ -0,0 +1,16 @@
+import Replicate from "replicate";
+
+const replicate = new Replicate({
+  auth: process.env.REPLICATE_API_TOKEN,
+});
+
+export default async function main() {
+  return await replicate.run(
+    "replicate/hello-world:5c7d5dc6dd8bf75c1acaa8565735e7986bc5b66206b55cca93cb72c9bf15ccaa",
+    {
+      input: {
+        text: "Evelyn ESM"
+      }
+    }
+  );
+};

integration/esm/index.js

@@ -0,0 +1,8 @@
+import { test } from 'node:test';
+import assert from 'node:assert';
+import main from './index.js';
+
+test('main', async () => {
+  const output = await main();
+  assert.equal(output, "hello Evelyn ESM");
+});

integration/esm/index.test.js

@@ -0,0 +1,14 @@
+{
+  "name": "replicate-app-esm",
+  "version": "0.0.0",
+  "private": true,
+  "description": "ESM (ECMAScript Modules) integration tests",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "test": "node --test ./index.test.js"
+  },
+  "dependencies": {
+    "replicate": "file:../../"
+  }
+}

integration/esm/package-lock.json

@@ -0,0 +1,24 @@
+import { test } from 'node:test';
+import assert from 'node:assert';
+import main from './index.js';
+
+// Verify exported types.
+import type { 
+  Status,
+  Visibility,
+  WebhookEventType,
+  ApiError,
+  Collection,
+  Hardware,
+  Model,
+  ModelVersion,
+  Prediction,
+  Training,
+  Page,
+  ServerSentEvent,
+} from "replicate";
+
+test('main', async () => {
+  const output = await main();
+  assert.equal(output, "hello Tracy TypeScript");
+});   

integration/esm/package.json

@@ -0,0 +1,16 @@
+import Replicate from "replicate";
+
+const replicate = new Replicate({
+  auth: process.env.REPLICATE_API_TOKEN,
+});
+
+export default async function main() {
+  return await replicate.run(
+    "replicate/hello-world:5c7d5dc6dd8bf75c1acaa8565735e7986bc5b66206b55cca93cb72c9bf15ccaa",
+    {
+      input: {
+        text: "Tracy TypeScript"
+      }
+    }
+  );
+};

integration/typescript/index.test.ts

@@ -0,0 +1,16 @@
+{
+  "name": "replicate-app-typescript",
+  "version": "0.0.0",
+  "private": true,
+  "description": "TypeScript integration tests",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "test": "tsc && node --test ./dist/index.test.js"
+  },
+  "dependencies": {
+    "@types/node": "^20.11.0",
+    "replicate": "file:../../",
+    "typescript": "^5.3.3"
+  }
+}