initial commit

Author: danielcondemarin

packages/s3-static-assets/README.md

@@ -0,0 +1,7 @@
+export const mockUpload = jest.fn();
+
+export default {
+  S3: jest.fn(() => ({
+    upload: mockUpload
+  }))
+};

packages/s3-static-assets/__mocks__/aws-sdk.ts

@@ -0,0 +1,66 @@
+import path from "path";
+import fse from "fs-extra";
+import mime from "mime-types";
+import klaw, { Item } from "klaw";
+import AWS from "aws-sdk";
+
+type UploadStaticAssetsOptions = {
+  bucketName: string;
+  nextAppDir: string;
+};
+
+const readDirectoryFiles = (directory: string): Promise<Array<Item>> => {
+  const items: Item[] = [];
+  return new Promise((resolve, reject) => {
+    klaw(directory.trim())
+      .on("data", item => items.push(item))
+      .on("end", () => {
+        resolve(items);
+      })
+      .on("error", reject);
+  });
+};
+
+const uploadStaticAssets = async (
+  options: UploadStaticAssetsOptions
+): Promise<void> => {
+  const { bucketName, nextAppDir } = options;
+
+  const s3 = new AWS.S3();
+
+  const dotNextDirectory = path.join(nextAppDir, ".next");
+
+  const BUILD_ID = fse
+    .readFileSync(path.join(dotNextDirectory, "BUILD_ID"))
+    .toString("utf8");
+
+  const buildStaticFiles = await readDirectoryFiles(
+    path.join(dotNextDirectory, "static", BUILD_ID)
+  );
+
+  const uploadTasks = buildStaticFiles
+    .filter(item => !item.stats.isDirectory())
+    .map(fileItem => {
+      return fse.readFile(fileItem.path).then(fileBodyStream =>
+        s3
+          .upload({
+            Bucket: bucketName,
+            Key: fileItem.path,
+            Body: fileBodyStream,
+            ContentType:
+              mime.lookup(path.basename(fileItem.path)) ||
+              "application/octet-stream",
+            CacheControl: "public, max-age=31536000, immutable"
+          })
+          .promise()
+      );
+    });
+
+  await Promise.all(uploadTasks);
+  // read public/ folder and upload files
+  // read static/ folder and upload files
+  // get HTML pages from pages manifest
+  // get JSON data files from prerender manifest
+};
+
+export default uploadStaticAssets;

packages/s3-static-assets/index.ts

@@ -0,0 +1,38 @@
+{
+  "name": "@sls-next/s3-static-assets",
+  "version": "1.0.0",
+  "description": "Handles upload to S3 of next.js static assets",
+  "main": "dist/index.js",
+  "directories": {
+    "test": "tests"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/danielcondemarin/serverless-next.js.git",
+    "directory": "packages/s3-static-assets"
+  },
+  "keywords": [
+    "AWS",
+    "S3",
+    "Next.js",
+    "Serverless"
+  ],
+  "author": "Daniel Conde Marin <danielconde9@gmail.com>",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/danielcondemarin/serverless-next.js/issues"
+  },
+  "homepage": "https://github.com/danielcondemarin/serverless-next.js#readme",
+  "dependencies": {
+    "aws-sdk": "^2.664.0",
+    "klaw": "^3.0.0",
+    "mime-types": "^2.1.27"
+  },
+  "devDependencies": {
+    "@types/klaw": "^3.0.1",
+    "@types/mime-types": "^2.1.0"
+  }
+}

packages/s3-static-assets/package-lock.json

@@ -0,0 +1,41 @@
+import stream from "stream";
+import fse from "fs-extra";
+import path from "path";
+import uploadStaticAssets from "../index";
+import { mockUpload } from "aws-sdk";
+
+declare module "aws-sdk" {
+  const mockUpload: jest.Mock;
+}
+
+describe("Upload assets tests", () => {
+  it("uploads any contents inside build directory specified in BUILD_ID", async () => {
+    await uploadStaticAssets({
+      bucketName: "test-bucket-name",
+      nextAppDir: path.join(__dirname, "./fixtures/basic-next-app")
+    });
+
+    const mockedBodyStream = new stream.Readable();
+    jest
+      .spyOn(fse, "readFile")
+      .mockResolvedValue(Promise.resolve(mockedBodyStream));
+
+    const expectedCacheControl = "public, max-age=31536000, immutable";
+
+    expect(mockUpload).toBeCalledWith({
+      Bucket: "test-bucket-name",
+      Key: "_next/static/a_test_build_id/testFileOne.js",
+      Body: mockedBodyStream,
+      ContentType: "application/javascript",
+      CacheControl: expectedCacheControl
+    });
+
+    expect(mockUpload).toBeCalledWith({
+      Bucket: "test-bucket-name",
+      Key: "_next/static/a_test_build_id/subdir/testFileTwo.js",
+      Body: mockedBodyStream,
+      ContentType: "application/javascript",
+      CacheControl: expectedCacheControl
+    });
+  });
+});

packages/s3-static-assets/package.json

@@ -0,0 +1,15 @@
+  "compilerOptions": {
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "declaration": true,
+    "target": "ES2015",
+    "module": "CommonJS",
+    "noImplicitAny": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "strict": true,
+    "allowJs": true
+  },
+  "exclude": ["node_modules"],
+  "include": ["**/*.ts"]
+}