1
// NPM Install Command: "npm install -D @aws-sdk/client-s3 @aws-sdk/client-cloudfront dotenv mime-types"
2
// NOTE: This command does NOT work correctly when bucket versioning is enabled.
3

4
// Use in GitHub Actions: https://github.com/Mohitjain49/mohit-website/blob/main/.github/workflows/main.yml#L30
5
// Run with "node scripts/deploy.mjs". You can make a reference to this in your package.json file.
6

7
import 'dotenv/config'; // Used To import .env variables independent from Vite.
8
import * as fs from "fs"; // The File System Module. Used to find and get data from files in the build output.
9
import * as path from 'path'; // The Path Module. Used to create path names and file names.
10
import { lookup } from 'mime-types'; // The lookup function here can generate the MIME type for every file we fetch.
11

12
import { S3Client, PutObjectCommand, DeleteObjectsCommand, paginateListObjectsV2 } from "@aws-sdk/client-s3"; // This module allows us to remove and send files to an Amazon S3 bucket.
13
import { CloudFrontClient, CreateInvalidationCommand } from '@aws-sdk/client-cloudfront'; // This module allows us invalidate a CloudFront Cache.
14

15
const BUILD_OUTPUT = (process.env.BUILD_OUTPUT ?? 'dist'); // This is the name of your folder where your application was built for deployment. Defaults to 'dist'.
16
const AWS_REGION = process.env.AWS_REGION; // This is the region where both the S3 bucket and CloudFront Distribution should be located (e.g. "us-east-1").
17
const AWS_BUCKET = process.env.AWS_BUCKET; // This is the name of the AWS bucket to send messages to. (e.g. "mohit-website").
18
const AWS_CLOUDFRONT_DIST_ID = process.env.AWS_CLOUDFRONT_DIST_ID; // This is the ID of your CloudFront Distribution (e.g. "EDFDVBD632BHDS5").
19
const AWS_ACCESS_KEY_ID = process.env.AWS_ACCESS_KEY_ID; // This serves as the access key for your IAM account (e.g. AKIAIOSFODNN7EXAMPLE).
20
const AWS_SECRET_ACCESS_KEY = process.env.AWS_SECRET_ACCESS_KEY; // This serves as the access key for your IAM account (e.g. wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY).
21

22
// console.log(BUILD_OUTPUT)
23
// console.log(AWS_REGION);
24
// console.log(AWS_BUCKET);
25
// console.log(AWS_CLOUDFRONT_DIST_ID);
26
// console.log(AWS_ACCESS_KEY_ID);
27
// console.log(AWS_SECRET_ACCESS_KEY);
28

29
const outDir = path.resolve(BUILD_OUTPUT); // The path that leads to the build output.
30
const args = process.argv.slice(2); // These are the arguments for altering how the script works.
31

32
const NO_DELETION = (args.findIndex(item => item === "--no-delete") != -1);
33
const NO_INVALIDATION = (args.findIndex(item => item === "--no-invalidation") != -1);
34

35
// If any of the 4 required environment variables are not defined, this will throw an error before the script starts.
36
if(!AWS_REGION || !AWS_BUCKET || !AWS_ACCESS_KEY_ID || !AWS_SECRET_ACCESS_KEY) {
37
    throw new Error("The mandatory environment variables are not properly configured.");
38
}
39
if(!AWS_CLOUDFRONT_DIST_ID && !NO_INVALIDATION) {
40
    throw new Error("No CloudFront Distribution ID Provided.");
41
}
42

43
/**
44
 * ----------------------------------------------------------
45
 * This section specifically handles commands with Amazon S3.
46
 * ----------------------------------------------------------
47
 */
48

49
/** The Client for Amazon S3. */
50
const s3Client = new S3Client({
51
    region: AWS_REGION,
52
    credentials: {
53
        accessKeyId: AWS_ACCESS_KEY_ID,
54
        secretAccessKey: AWS_SECRET_ACCESS_KEY
55
    }
56
});
57

58
/**
59
 * This function sends a command via the S3 client.
60
 * @param {PutObjectCommand | DeleteObjectsCommand} command the command for the S3 client to send.
61
 */
62
async function sendS3Command(command) {
63
    return await s3Client.send(command);
64
}
65

66
/**
67
 * This function returns all the put object commands that will be sent by the S3 client.
68
 */
69
function getPutObjectCommands() {
70
    /** @type {Array<String>} All the filenames from the build output. */
71
    const allFiles = fs.readdirSync(outDir, { recursive: true });
72

73
    const assetFolders = ["_nuxt/", "_fonts/"];
74
    const commands = [];
75

76
    for(let i = 0; i < allFiles.length; i++) {
77
        const filename = allFiles[i].replaceAll("\\", "/");
78
        const mimeType = lookup(filename);
79
        const filePath = path.join(outDir, filename);
80

81
        if(!fs.statSync(filePath).isFile()) { continue; }
82
        if(!mimeType || mimeType === "application/x-install-instructions") { continue; }
83

84
        commands.push(new PutObjectCommand({
85
            Body: fs.createReadStream(filePath),
86
            Bucket: AWS_BUCKET,
87
            Key: filename,
88
            ContentType: ((mimeType === "text/javascript") ? "application/javascript" : mimeType),
89
            CacheControl: ((filename.startsWith(assetFolders[0]) || filename.startsWith(assetFolders[1])) ?
90
                "public, max-age=2592000, no-cache" :
91
                "no-cache, no-store, must-revalidate"
92
            )
93
        }));
94
    }
95

96
    // Returns all the "Put Object" commands for use.
97
    return commands;
98
}
99

100
/**
101
 * This function returns commands to delete ALL the objects currently in an array.
102
 */
103
async function getDeleteObjectCommands() {
104
    // This gets all the current objects in the bucket.
105
    const paginator = paginateListObjectsV2(
106
        { client: s3Client },
107
        { Bucket: AWS_BUCKET }
108
    );
109

110
    // This gets all the keys.
111
    const objectKeys = [];
112
    for await (const { Contents } of paginator) {
113
        objectKeys.push(...Contents.map((obj) => ({ Key: obj.Key })));
114
    }
115

116
    // This creates and returns the commands.
117
    const deleteCommands = [];
118
    while(objectKeys.length != 0) {
119
        deleteCommands.push(new DeleteObjectsCommand({
120
            Bucket: AWS_BUCKET,
121
            Delete: { Objects: objectKeys.splice(0, Math.min(objectKeys.length, 1000)) }
122
        }));
123
    }
124
    return deleteCommands;
125
};
126

127
/**
128
 * ---------------------------------------------------------------------------------------------
129
 * This section specifically invalidates the Amazon CloudFront Cache that delivers the S3 files.
130
 * ---------------------------------------------------------------------------------------------
131
 */
132

133
/** The Client for Amazon CloudFront. */
134
const cloudfrontClient = new CloudFrontClient({
135
    region: AWS_REGION,
136
    credentials: {
137
        accessKeyId: AWS_ACCESS_KEY_ID,
138
        secretAccessKey: AWS_SECRET_ACCESS_KEY
139
    }
140
});
141

142
/**
143
 * This function sends an Invalidation command to the website's cloudfront distribution.
144
 */
145
async function sendCloudfrontInvalidation() {
146
    return cloudfrontClient.send(new CreateInvalidationCommand({
147
        DistributionId: AWS_CLOUDFRONT_DIST_ID,
148
        InvalidationBatch: {
149
            CallerReference: Date.now(),
150
            Paths: { Quantity: 1, Items: ["/*"] }
151
        }
152
    }));
153
}
154

155
/**
156
 * -----------------------------------------------------------------------------
157
 * This part below fully starts the script and runs all the necessary functions.
158
 * -----------------------------------------------------------------------------
159
 */
160

161
/** This is the main function to run at the end once all objects are initialized. */
162
async function main() {
163
    try {
164
        // Unless an argument is passed in, this deletes all current files in the bucket.
165
        if(!NO_DELETION) {
166
            const deleteCommands = await getDeleteObjectCommands();
167
            for(let j = 0; j < deleteCommands.length; j++) { await sendS3Command(deleteCommands[j]); }
168
            console.log(`✅ Deleted All Files From Bucket!\n`);
169
        }
170

171
        const commands = getPutObjectCommands();
172
        const length = commands.length;
173

174
        // This sends all the files in the build output to the bucket, replacing any files with the same key.
175
        for(let i = 0; i < length; i++) {
176
            await sendS3Command(commands[i]);
177
            console.log(`✅ Uploaded file ${i + 1} of ${length}: ${commands[i].input.Key}`);
178
        }
179
        console.log(`✅ Uploaded All Files To Your Bucket!\n`);
180

181
        // Unless an argument is passed in, this invalidates a cloudfront cache.
182
        if(!NO_INVALIDATION) {
183
            await sendCloudfrontInvalidation();
184
            console.log("✅ Completed CloudFront Cache Invalidation!");
185
        }
186

187
        // This marks the deployment as complete.
188
        console.log("🏁 Script Complete!");
189
        process.exit(0);
190
    } catch(err) {
191
        console.error(err);
192
        process.exit(1);
193
    }
194
}
195

196
// Runs The Main Function.
197
await main();